Diff for /loncom/interface/loncommon.pm between versions 1.572 and 1.692.4.19

version 1.572, 2007/08/28 18:32:36 version 1.692.4.19, 2009/10/12 18:28:12
Line 61  use POSIX qw(strftime mktime); Line 61  use POSIX qw(strftime mktime);
 use Apache::lonmenu();  use Apache::lonmenu();
 use Apache::lonenc();  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 Apache::lonclonecourse();
 use LONCAPA qw(:DEFAULT :match);  use LONCAPA qw(:DEFAULT :match);
   use DateTime::TimeZone;
   use DateTime::Locale::Catalog;
   
 # ---------------------------------------------- Designs  # ---------------------------------------------- Designs
 use vars qw(%defaultdesign);  use vars qw(%defaultdesign);
Line 78  my $readit; Line 81  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 214  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 234  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 257  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 318  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 332  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,ignorefilter) {      function openstdbrowser(formname,uname,udom,roleflag,ignorefilter,courseadvonly) {
         var url = '/adm/pickstudent?';          var url = '/adm/pickstudent?';
         var filter;          var filter;
  if (!ignorefilter) {   if (!ignorefilter) {
Line 348  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.'","","1");'."'>".&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">
   // <![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,$sec_element,$formname)=@_;      my ($domainfilter,$sec_element,$formname)=@_;
     my $crs_or_grp_alert = &mt('Please select the type of LON-CAPA entity - Course or Group - for which you wish to add/modify a user role');      my $crs_or_grp_alert = &mt('Please select the type of LON-CAPA entity - Course or Community - for which you wish to add/modify a user role.');
    my $output = '      my $id_functions = &javascript_index_functions();
 <script type="text/javascript">      my $output = '
   <script type="text/javascript" language="JavaScript">
   // <![CDATA[
     var stdeditbrowser;'."\n";      var stdeditbrowser;'."\n";
    $output .= <<"ENDSTDBRW";  
       $output .= <<"ENDSTDBRW";
     function opencrsbrowser(formname,uname,udom,desc,extra_element,multflag,crstype) {      function opencrsbrowser(formname,uname,udom,desc,extra_element,multflag,crstype) {
         var url = '/adm/pickcourse?';          var url = '/adm/pickcourse?';
         var domainfilter = '';  
         var formid = getFormIdByName(formname);          var formid = getFormIdByName(formname);
         if (formid > -1) {          var domainfilter = getDomainFromSelectbox(formname,udom);
             var domid = getIndexByName(formid,udom);  
             if (domid > -1) {  
                 if (document.forms[formid].elements[domid].type == 'select-one') {  
                     domainfilter=document.forms[formid].elements[domid].options[document.forms[formid].elements[domid].selectedIndex].value;  
                 }  
                 if (document.forms[formid].elements[domid].type == 'hidden') {  
                     domainfilter=document.forms[formid].elements[domid].value;  
                 }  
             }  
         }  
         if (domainfilter != null) {          if (domainfilter != null) {
            if (domainfilter != '') {             if (domainfilter != '') {
                url += 'domainfilter='+domainfilter+'&';                 url += 'domainfilter='+domainfilter+'&';
Line 407  sub coursebrowser_javascript { Line 503  sub coursebrowser_javascript {
                             '&cdomelement='+udom+                              '&cdomelement='+udom+
                                     '&cnameelement='+desc;                                      '&cnameelement='+desc;
         if (extra_element !=null && extra_element != '') {          if (extra_element !=null && extra_element != '') {
             if (formname == 'rolechoice') {              if (formname == 'rolechoice' || formname == 'studentform') {
                 url += '&roleelement='+extra_element;                  url += '&roleelement='+extra_element;
                 if (domainfilter == null || domainfilter == '') {                  if (domainfilter == null || domainfilter == '') {
                     url += '&domainfilter='+extra_element;                      url += '&domainfilter='+extra_element;
Line 419  sub coursebrowser_javascript { Line 515  sub coursebrowser_javascript {
                 }                  }
             }                   }     
         }          }
           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;
         }          }
         if (crstype == 'Course/Group') {          if (crstype == 'Course/Community') {
             if (formname == 'cu') {              if (formname == 'cu') {
                 crstype = document.cu.crstype.options[document.cu.crstype.selectedIndex].value;                   crstype = document.cu.crstype.options[document.cu.crstype.selectedIndex].value; 
                 if (crstype == "") {                  if (crstype == "") {
Line 440  sub coursebrowser_javascript { Line 541  sub coursebrowser_javascript {
         stdeditbrowser = open(url,title,options,'1');          stdeditbrowser = open(url,title,options,'1');
         stdeditbrowser.focus();          stdeditbrowser.focus();
     }      }
   $id_functions
   ENDSTDBRW
       if ($sec_element ne '') {
           $output .= &setsec_javascript($sec_element,$formname);
       }
       $output .= '
   // ]]>
   </script>';
       return $output;
   }
   
     function getFormIdByName(formname) {  sub javascript_index_functions {
         for (var i=0;i<document.forms.length;i++) {      return <<"ENDJS";
             if (document.forms[i].name == formname) {  
                 return i;  function getFormIdByName(formname) {
             }      for (var i=0;i<document.forms.length;i++) {
           if (document.forms[i].name == formname) {
               return i;
         }          }
         return -1;   
     }      }
       return -1;
   }
   
     function getIndexByName(formid,item) {  function getIndexByName(formid,item) {
         for (var i=0;i<document.forms[formid].elements.length;i++) {      for (var i=0;i<document.forms[formid].elements.length;i++) {
             if (document.forms[formid].elements[i].name == item) {          if (document.forms[formid].elements[i].name == item) {
                 return i;              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 -1;  
     }      }
 ENDSTDBRW      return userdom;
     if ($sec_element ne '') {  }
         $output .= &setsec_javascript($sec_element,$formname);  
   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+'&';
          }
     }      }
     $output .= '      url += 'form=' + formname + '&unameelement='+uname+
 </script>';                                  '&udomelement='+udom+
     return $output;                                  '&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 {  sub setsec_javascript {
     my ($sec_element,$formname) = @_;      my ($sec_element,$formname) = @_;
     my $setsections = qq|      my $setsections = qq|
 function setSect(sectionlist) {  function setSect(sectionlist) {
     var sectionsArray = sectionlist.split(",");      var sectionsArray = new Array();
       if ((sectionlist != '') && (typeof sectionlist != "undefined")) {
           sectionsArray = sectionlist.split(",");
       }
     var numSections = sectionsArray.length;      var numSections = sectionsArray.length;
     document.$formname.$sec_element.length = 0;      document.$formname.$sec_element.length = 0;
     if (numSections == 0) {      if (numSections == 0) {
Line 506  function setSect(sectionlist) { Line 698  function setSect(sectionlist) {
   
 sub selectcourse_link {  sub selectcourse_link {
    my ($form,$unameele,$udomele,$desc,$extra_element,$multflag,$selecttype)=@_;     my ($form,$unameele,$udomele,$desc,$extra_element,$multflag,$selecttype)=@_;
    return "<a href='".'javascript:opencrsbrowser("'.$form.'","'.$unameele.     my $linktext = &mt('Select Course');
         '","'.$udomele.'","'.$desc.'","'.$extra_element.'","'.$multflag.'","'.$selecttype.'");'."'>".&mt('Select Course')."</a>";     if ($selecttype eq 'Community') {
          $linktext = &mt('Select Community');
      }
      return '<span class="LC_nobreak">'
            ."<a href='"
            .'javascript:opencrsbrowser("'.$form.'","'.$unameele
            .'","'.$udomele.'","'.$desc.'","'.$extra_element
            .'","'.$multflag.'","'.$selecttype.'");'
            ."'>".$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 535  ENDSCRT Line 750  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 562  linked_select_forms takes the following Line 864  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 578  $menu{$choice1}->{'select2'}. Line 882  $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 586  $menu{$choice1}->{'select2'}. Line 891  $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 598  $menu{$choice1}->{'select2'}. Line 904  $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 610  sub linked_select_forms { Line 917  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 624  sub linked_select_forms { Line 933  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 659  function select1_changed() { Line 971  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 673  END Line 990  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 685  END Line 1007  END
   
 =pod  =pod
   
 =item * help_open_topic($topic, $text, $stayOnPage, $width, $height)  =item * &help_open_topic($topic,$text,$stayOnPage,$width,$height)
   
 Returns a string corresponding to an HTML link to the given help  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 734  sub help_open_topic { Line 1056  sub help_open_topic {
     if ($text ne "") {      if ($text ne "") {
  $template .=    $template .= 
             "<table bgcolor='#3333AA' cellspacing='1' cellpadding='1' border='0'><tr>".              "<table bgcolor='#3333AA' cellspacing='1' cellpadding='1' border='0'><tr>".
             "<td bgcolor='#5555FF'><a target=\"_top\" href=\"$link\"><font color='#FFFFFF' size='2'>$text</font></a>";              "<td bgcolor='#5555FF'><span class=\"LC_nobreak\"><a target=\"_top\" href=\"$link\"><font color='#FFFFFF' size='2'>$text</font></a>";
     }      }
   
     # Add the graphic      # Add the graphic
     my $title = &mt('Online Help');      my $title = &mt('Online Help');
     my $helpicon=&lonhttpdurl("/adm/help/gif/smallHelp.gif");      my $helpicon=&lonhttpdurl("/adm/help/help.png");
     $template .= <<"ENDTEMPLATE";      $template .= '<a target="_top" href="'.$link.'" title="'.$title.'">'.
  <a target="_top" href="$link" title="$title"><img src="$helpicon" border="0" alt="(Help: $topic)" /></a>                   '<img src="'.$helpicon.'" border="0" alt="'.&mt('Help: [_1]',$topic).
 ENDTEMPLATE                   '" title="'.$title.'" /></a>';
     if ($text ne '') { $template.='</td></tr></table>' };      if ($text ne '') {
           $template.='</span></td></tr></table>';
       }
     return $template;      return $template;
   
 }  }
Line 751  ENDTEMPLATE Line 1075  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 = &Apache::loncommon::help_open_topic($topic,$text,
        undef, undef, 600) .         undef, undef, 600) .
    '</td><td>';     '</td><td>';
     }      }
     return '<table><tr><td>'.      $out = '<table><tr><td>'.
  $addOther .             $addOther .
  &Apache::loncommon::help_open_topic("Greek_Symbols",'Greek Symbols',             &Apache::loncommon::help_open_topic("Greek_Symbols",&mt('Greek Symbols'),
     undef,undef,600)                                                 undef,undef,600).
  .'</td><td>'.             '</td><td>'.
  &Apache::loncommon::help_open_topic("Other_Symbols",'Other Symbols',             &Apache::loncommon::help_open_topic("Other_Symbols",&mt('Other Symbols'),
     undef,undef,600)                                                 undef,undef,600).
  .'</td></tr></table>';             '</td>';
       unless ($not_author) {
           $out .= '<td>'.
                   &Apache::loncommon::help_open_topic("Authoring_Output_Tags",&mt('Output Tags'),
                                                       undef,undef,600).
                   '</td>';
       }
       $out .= '</tr></table>';
       return $out;
 }  }
   
 sub general_help {  sub general_help {
Line 774  sub general_help { Line 1107  sub general_help {
  $helptopic='Authoring_Intro';   $helptopic='Authoring_Intro';
     } elsif ($env{'request.role'}=~/^cc/) {      } elsif ($env{'request.role'}=~/^cc/) {
  $helptopic='Course_Coordination_Intro';   $helptopic='Course_Coordination_Intro';
       } elsif ($env{'request.role'}=~/^dc/) {
           $helptopic='Domain_Coordination_Intro';
     }      }
     return $helptopic;      return $helptopic;
 }  }
Line 790  sub update_help_link { Line 1125  sub update_help_link {
     my $banner_link = "/adm/helpmenu?page=banner&amp;topic=$topic&amp;component_help=$component_help&amp;faq=$faq&amp;bug=$bug&amp;origurl=$origurl&amp;stamp=$timestamp&amp;stayonpage=$stayOnPage";      my $banner_link = "/adm/helpmenu?page=banner&amp;topic=$topic&amp;component_help=$component_help&amp;faq=$faq&amp;bug=$bug&amp;origurl=$origurl&amp;stamp=$timestamp&amp;stayonpage=$stayOnPage";
     my $output .= <<"ENDOUTPUT";      my $output .= <<"ENDOUTPUT";
 <script type="text/javascript">  <script type="text/javascript">
   // <![CDATA[
 banner_link = '$banner_link';  banner_link = '$banner_link';
   // ]]>
 </script>  </script>
 ENDOUTPUT  ENDOUTPUT
     return $output;      return $output;
Line 860  sub help_menu_js { Line 1197  sub help_menu_js {
  '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,});
   
     my $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 = '';  var banner_link = '';
 function helpMenu(target) {  function helpMenu(target) {
     var caller = this;      var caller = this;
Line 893  function writeHelp(caller) { Line 1230  function writeHelp(caller) {
     caller.document.close()      caller.document.close()
     caller.focus()      caller.focus()
 }  }
 // ]]>  
 // END LON-CAPA Internal -->  // END LON-CAPA Internal -->
   // ]]>
 </script>  </script>
 ENDTEMPLATE  ENDTEMPLATE
     return $template;      return $template;
Line 995  ENDTEMPLATE Line 1332  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 1050  DOMBASED Line 1387  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 1074  sub changable_area { Line 1411  sub changable_area {
   
 =pod  =pod
   
 =item * resize_textarea_js  =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  emits the needed javascript to resize a textarea to be as big as possible
   
Line 1083  the id of the element to resize, second Line 1491  the id of the element to resize, second
 surrounds everything that comes after the textarea, this routine needs  surrounds everything that comes after the textarea, this routine needs
 to be attached to the <body> for the onload and onresize events.  to be attached to the <body> for the onload and onresize events.
   
   =back
   
 =cut  =cut
   
 sub resize_textarea_js {  sub resize_textarea_js {
       my $geometry = &viewport_geometry_js();
     return <<"RESIZE";      return <<"RESIZE";
     <script type="text/javascript">      <script type="text/javascript">
 var Geometry = {};  // <![CDATA[
 function init_geometry() {  $geometry
     if (Geometry.init) { return };  
     Geometry.init=1;  function getX(element) {
     if (window.innerHeight) {      var x = 0;
  Geometry.getViewportHeight = function() { return window.innerHeight; };      while (element) {
     }   x += element.offsetLeft;
     else if (document.documentElement && document.documentElement.clientHeight) {   element = element.offsetParent;
  Geometry.getViewportHeight =       }
     function() { return document.documentElement.clientHeight; };      return x;
     }  }
     else if (document.body.clientHeight) {  function getY(element) {
  Geometry.getViewportHeight =       var y = 0;
     function() { return document.body.clientHeight; };      while (element) {
    y += element.offsetTop;
    element = element.offsetParent;
     }      }
       return y;
 }  }
   
   
 function resize_textarea(textarea_id,bottom_id) {  function resize_textarea(textarea_id,bottom_id) {
     init_geometry();      init_geometry();
     var textarea        = document.getElementById(textarea_id);      var textarea        = document.getElementById(textarea_id);
     //alert(textarea);      //alert(textarea);
   
     var textarea_top    = textarea.offsetTop;      var textarea_top    = getY(textarea);
     var textarea_height = textarea.offsetHeight;      var textarea_height = textarea.offsetHeight;
     var bottom          = document.getElementById(bottom_id);      var bottom          = document.getElementById(bottom_id);
     var bottom_top      = bottom.offsetTop;      var bottom_top      = getY(bottom);
     var bottom_height   = bottom.offsetHeight;      var bottom_height   = bottom.offsetHeight;
     var window_height   = Geometry.getViewportHeight();      var window_height   = Geometry.getViewportHeight();
     var fudge           = 23;       var fudge           = 23;
     var new_height      = window_height-fudge-textarea_top-bottom_height;      var new_height      = window_height-fudge-textarea_top-bottom_height;
     if (new_height < 300) {      if (new_height < 300) {
  new_height = 300;   new_height = 300;
     }      }
     textarea.style.height=new_height+'px';      textarea.style.height=new_height+'px';
 }  }
   // ]]>
 </script>  </script>
 RESIZE  RESIZE
   
Line 1131  RESIZE Line 1546  RESIZE
   
 =pod  =pod
   
 =back  
    
 =head1 Excel and CSV file utility routines  =head1 Excel and CSV file utility routines
   
 =over 4  =over 4
Line 1144  RESIZE Line 1557  RESIZE
   
 =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 1165  sub csv_translate { Line 1578  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 1221  sub define_excel_formats { Line 1634  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 1264  sub create_workbook { Line 1677  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 user.  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 
Line 1289  sub create_text_file { Line 1702  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(&mt('Problems occurred in creating the output file. '
                   "This error has been logged.  ".                       .'This error has been logged. '
                   "Please alert your LON-CAPA administrator.");                       .'Please alert your LON-CAPA administrator.'));
     }      }
     return ($fh,$filename)      return ($fh,$filename)
 }  }
Line 1332  sub domain_select { Line 1745  sub domain_select {
   
 =over 4  =over 4
   
 =cut  =item * &multiple_select_form($name,$value,$size,$hash,$order)
   
 =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
   
Line 1360  sub multiple_select_form { Line 1771  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;      my @order;
     if (ref($order) eq 'ARRAY')  {      if (ref($order) eq 'ARRAY')  {
         @order = @{$order};          @order = @{$order};
Line 1384  sub multiple_select_form { Line 1795  sub multiple_select_form {
   
 =pod  =pod
   
 =item * select_form($defdom,$name,%hash)  =item * &select_form($defdom,$name,%hash)
   
 Returns a string containing a <select name='$name' size='1'> form to   Returns a string containing a <select name='$name' size='1'> form to 
 allow a user to select options from a hash option_name => displayed text.    allow a user to select options from a hash option_name => displayed text.  
Line 1417  sub select_form { Line 1828  sub select_form {
 sub display_filter {  sub display_filter {
     if (!$env{'form.show'}) { $env{'form.show'}=10; }      if (!$env{'form.show'}) { $env{'form.show'}=10; }
     if (!$env{'form.displayfilter'}) { $env{'form.displayfilter'}='currentfolder'; }      if (!$env{'form.displayfilter'}) { $env{'form.displayfilter'}='currentfolder'; }
     return '<nobr><label>'.&mt('Records [_1]',      return '<span class="LC_nobreak"><label>'.&mt('Records [_1]',
        &Apache::lonmeta::selectbox('show',$env{'form.show'},undef,         &Apache::lonmeta::selectbox('show',$env{'form.show'},undef,
    (&mt('all'),10,20,50,100,1000,10000))).     (&mt('all'),10,20,50,100,1000,10000))).
    '</label></nobr> <nobr>'.     '</label></span> <span class="LC_nobreak">'.
            &mt('Filter [_1]',             &mt('Filter [_1]',
    &select_form($env{'form.displayfilter'},     &select_form($env{'form.displayfilter'},
  'displayfilter',   'displayfilter',
  ('currentfolder' => 'Current folder/page',   ('currentfolder' => 'Current folder/page',
  'containing' => 'Containing phrase',   'containing' => 'Containing phrase',
  'none' => 'None'))).   'none' => 'None'))).
  '<input type="text" name="containingphrase" size="30" value="'.&HTML::Entities::encode($env{'form.containingphrase'}).'" /></nobr>';   '<input type="text" name="containingphrase" size="30" value="'.&HTML::Entities::encode($env{'form.containingphrase'}).'" /></span>';
 }  }
   
 sub gradeleveldescription {  sub gradeleveldescription {
Line 1471  sub select_level_form { Line 1882  sub select_level_form {
   
 =pod  =pod
   
 =item * select_dom_form($defdom,$name,$includeempty,$showdomdesc)  =item * &select_dom_form($defdom,$name,$includeempty,$showdomdesc,$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 the domain to preform an operation in.    allow a user to select the domain to preform an operation in.  
Line 1480  See loncreateuser.pm for an example invo Line 1891  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.   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.
   
 =cut  =cut
   
 #-------------------------------------------  #-------------------------------------------
 sub select_dom_form {  sub select_dom_form {
     my ($defdom,$name,$includeempty,$showdomdesc) = @_;      my ($defdom,$name,$includeempty,$showdomdesc,$onchange) = @_;
       if ($onchange) {
           $onchange = ' onchange="'.$onchange.'"';
       }
     my @domains = sort {lc($a) cmp lc($b)} (&Apache::lonnet::all_domains());      my @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;              ($dom eq $defdom ? 'selected="selected" ' : '').'>'.$dom;
Line 1511  sub select_dom_form { Line 1927  sub select_dom_form {
   
 =pod  =pod
   
 =item * home_server_option_list($domain)  =item * &home_server_form_item($domain,$name,$defaultflag)
   
   input: 4 arguments (two required, two optional) - 
       $domain - domain of new user
       $name - name of form element
       $default - Value of 'default' causes a default item to be first 
                               option, and selected by default. 
       $hide - Value of 'hide' causes hiding of the name of the server, 
                               if 1 server found, or default, if 0 found.
   output: returns 2 items: 
   (a) form element which contains either:
      (i) <select name="$name">
           <option value="$hostid1">$hostid $servers{$hostid}</option>
           <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.
   
 returns a string which contains an <option> list to be used in a   (b) number of library servers found.
 <select> form input.  See loncreateuser.pm for an example.  
   See loncreateuser.pm for example of use.
   
 =cut  =cut
   
 #-------------------------------------------  #-------------------------------------------
 sub home_server_option_list {  sub home_server_form_item {
     my $domain = shift;      my ($domain,$name,$default,$hide) = @_;
     my %servers = &Apache::lonnet::get_servers($domain,'library');      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
Line 1627  sub decode_user_agent { Line 2087  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 1651  See loncreateuser.pm for invocation and Line 2109  See loncreateuser.pm for invocation and
   
 =back  =back
   
 =back   See loncreateuser.pm for invocation and use examples.
   
 =cut  =cut
   
Line 1681  END Line 2139  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 1776  sub authform_nochange{ Line 2231  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 1858  sub authform_local{ Line 2415  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 1885  sub authform_filesystem{ Line 2469  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($domain,'auth_def'),          }
     &Apache::lonnet::domain($domain,'auth_arg_def'));      }
           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 1943  sub get_auth_defaults { Line 2572  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 1967  sub get_kerberos_defaults { Line 2605  sub get_kerberos_defaults {
     return ($krbdef,$krbdefdom);      return ($krbdef,$krbdefdom);
 }  }
   
 =pod  
   
 =back  
   
 =cut  
   
 ###############################################################  ###############################################################
 ##                Thesaurus Functions                        ##  ##                Thesaurus Functions                        ##
Line 1983  sub get_kerberos_defaults { Line 2616  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 2020  sub initialize_keywords { Line 2653  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 2028  sub initialize_keywords { Line 2661  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 2049  sub keyword { Line 2682  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 2107  sub get_related_words { Line 2740  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 2136  sub plainname { Line 2769  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 2186  sub getnames { Line 2819  sub getnames {
 }  }
   
 # -------------------------------------------------------------------- getemails  # -------------------------------------------------------------------- getemails
   
 =pod  =pod
   
 =item * getemails($uname,$udom)  =item * &getemails($uname,$udom)
   
 Gets a user's email information and returns it as a hash with keys:  Gets a user's email information and returns it as a hash with keys:
 notification, critnotification, permanentemail  notification, critnotification, permanentemail
   
 For notification and critnotification, values are comma-separated lists   For notification and critnotification, values are comma-separated lists 
 of e-mail address(es); for permanentemail, value is a single e-mail address.  of e-mail addresses; for permanentemail, value is a single e-mail address.
     
   
 =cut  =cut
   
   
 sub getemails {  sub getemails {
     my ($uname,$udom)=@_;      my ($uname,$udom)=@_;
     if ($udom eq 'public' && $uname eq 'public') {      if ($udom eq 'public' && $uname eq 'public') {
Line 2228  sub flush_email_cache { Line 2864  sub flush_email_cache {
     &Apache::lonnet::devalidate_cache_new('emailscache',$id);      &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 2246  sub screenname { Line 2919  sub screenname {
     return $names{'screenname'};      return $names{'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
   
Line 2272  sub aboutmewrapper { Line 2964  sub aboutmewrapper {
         return;          return;
     }      }
     return '<a href="/adm/'.$domain.'/'.$username.'/aboutme"'.      return '<a href="/adm/'.$domain.'/'.$username.'/aboutme"'.
  ($target?' target="$target"':'').' title="'.&mt("View this user's personal page").'">'.$link.'</a>';   ($target?' target="$target"':'').' title="'.&mt("View this user's personal information page").'">'.$link.'</a>';
 }  }
   
 # ------------------------------------------------------------ Syllabus Wrapper  # ------------------------------------------------------------ Syllabus Wrapper
Line 2287  sub syllabuswrapper { Line 2979  sub syllabuswrapper {
 }  }
   
 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 2301  sub track_student_link { Line 2993  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);      $title = &mt($title);
     $linktext = &mt($linktext);      $linktext = &mt($linktext);
     return qq{<a href="$link" title="$title" $target>$linktext</a>}.      return qq{<a href="$link" title="$title" $target>$linktext</a>}.
  &help_open_topic('View_recent_activity');   &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>};
   # FIXME uncomment when help item created: &help_open_topic('Slot_Reservation_History');
   
   }
   
 # ===================================================== Display a student photo  # ===================================================== Display a student photo
   
   
Line 2328  sub student_image_tag { Line 3042  sub student_image_tag {
   
 =over 4  =over 4
   
 =item * languageids()   =item * &languageids() 
   
 returns list of all language ids  returns list of all language ids
   
Line 2340  sub languageids { Line 3054  sub languageids {
   
 =pod  =pod
   
 =item * languagedescription()   =item * &languagedescription() 
   
 returns description of a specified language id  returns description of a specified language id
   
Line 2365  sub supportedlanguagecode { Line 3079  sub supportedlanguagecode {
   
 =pod  =pod
   
 =item * copyrightids()   =item * &copyrightids() 
   
 returns list of all copyrights  returns list of all copyrights
   
Line 2377  sub copyrightids { Line 3091  sub copyrightids {
   
 =pod  =pod
   
 =item * copyrightdescription()   =item * &copyrightdescription() 
   
 returns description of a specified copyright id  returns description of a specified copyright id
   
Line 2389  sub copyrightdescription { Line 3103  sub copyrightdescription {
   
 =pod  =pod
   
 =item * source_copyrightids()   =item * &source_copyrightids() 
   
 returns list of all source copyrights  returns list of all source copyrights
   
Line 2401  sub source_copyrightids { Line 3115  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 2413  sub source_copyrightdescription { Line 3127  sub source_copyrightdescription {
   
 =pod  =pod
   
 =item * filecategories()   =item * &filecategories() 
   
 returns list of all file categories  returns list of all file categories
   
Line 2425  sub filecategories { Line 3139  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 2439  sub filecategorytypes { Line 3153  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 2463  sub filecategoryselect { Line 3177  sub filecategoryselect {
   
 =pod  =pod
   
 =item * filedescription()   =item * &filedescription() 
   
 returns description for a specified file type  returns description for a specified file type
   
Line 2477  sub filedescription { Line 3191  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 2509  sub fileextensions { Line 3223  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 2521  sub display_languages { Line 3235  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=(@languages,      return $preferred_langs[0];
     split(/\s*(\,|\;|\:)\s*/,$env{'environment.languages'}));   }
     }      }
     my $browser=(split(/\;/,$ENV{'HTTP_ACCEPT_LANGUAGE'}))[0];      my %possibilities = map { $_ => 1 } (@$possible_langs);
     if ($browser) {      my @preferred_possibilities;
  @languages=(@languages,split(/\s*(\,|\;|\:)\s*/,$browser));      foreach my $preferred_lang (@preferred_langs) {
     }   if (exists($possibilities{$preferred_lang})) {
     if (&Apache::lonnet::domain($env{'user.domain'},'lang_def')) {      push(@preferred_possibilities, $preferred_lang);
  @languages=(@languages,  
     &Apache::lonnet::domain($env{'user.domain'},  
     'lang_def'));  
     }  
     if (&Apache::lonnet::domain($env{'request.role.domain'},'lang_def')) {  
  @languages=(@languages,  
     &Apache::lonnet::domain($env{'request.role.domain'},  
     'lang_def'));  
     }  
     if (&Apache::lonnet::domain($Apache::lonnet::perlvar{'lonDefDomain'},  
  'lang_def')) {  
  @languages=(@languages,  
     &Apache::lonnet::domain($Apache::lonnet::perlvar{'lonDefDomain'},  
     'lang_def'));  
     }  
 # turn "en-ca" into "en-ca,en"  
     my @genlanguages;  
     foreach my $lang (@languages) {  
  unless ($lang=~/\w/) { next; }  
  push (@genlanguages,$lang);  
  if ($lang=~/(\-|\_)/) {  
     push(@genlanguages,(split(/(\-|\_)/,$lang))[0]);  
  }   }
     }      }
     return @genlanguages;      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;
 }  }
   
 ###############################################################  ###############################################################
Line 2573  sub preferred_languages { Line 3290  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 2617  sub get_previous_attempt { Line 3334  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>';
       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>';    $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 2633  sub get_previous_attempt { Line 3350  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>';    $prevattempts.=&start_data_table_row().
         '<td>'.&mt('Transaction [_1]',$version).'</td>';
     foreach my $key (sort(keys(%lasthash))) {      foreach my $key (sort(keys(%lasthash))) {
        my $value;   my $value = &format_previous_attempt_value($key,
        if ($key =~ /timestamp/) {     $returnhash{$version.':'.$key});
   $value=scalar(localtime($returnhash{$version.':'.$key}));   $prevattempts.='<td>'.$value.'&nbsp;</td>';   
        } else {  
   $value=$returnhash{$version.':'.$key};  
        }  
        $prevattempts.='<td>'.&unescape($value).'&nbsp;</td>';     
     }      }
     $prevattempts.=&end_data_table_row();
  }   }
       }        }
       $prevattempts.='</tr><tr bgcolor="#ffffe6"><td>Current</td>';        $prevattempts.=&start_data_table_row().'<td>'.&mt('Current').'</td>';
       foreach my $key (sort(keys(%lasthash))) {        foreach my $key (sort(keys(%lasthash))) {
  my $value;   my $value = &format_previous_attempt_value($key,$lasthash{$key});
  if ($key =~ /timestamp/) {  
   $value=scalar(localtime($lasthash{$key}));  
  } else {  
   $value=$lasthash{$key};  
  }  
  $value=&unescape($value);  
  if ($key =~/$regexp$/ && (defined &$gradesub)) {$value = &$gradesub($value)}   if ($key =~/$regexp$/ && (defined &$gradesub)) {$value = &$gradesub($value)}
  $prevattempts.='<td>'.$value.'&nbsp;</td>';   $prevattempts.='<td>'.$value.'&nbsp;</td>';
       }        }
       $prevattempts.='</tr></table></td></tr></table>';        $prevattempts.= &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 2689  sub relative_to_absolute { Line 3418  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 2705  sub relative_to_absolute { Line 3434  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 2724  sub get_student_view { Line 3453  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 2733  sub get_student_view { Line 3462  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 2826  sub pprmlink { Line 3587  sub pprmlink {
     if (!$symb) { $symb=&Apache::lonnet::symbread(); }      if (!$symb) { $symb=&Apache::lonnet::symbread(); }
     $symb=&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 2842  sub pprmlink { Line 3603  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 {  sub utc_string {
Line 2861  sub utc_string { Line 3627  sub utc_string {
   
 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 3211  sub blocking_status { Line 3995  sub blocking_status {
                              &Apache::lonnet::coursedescription($course);                               &Apache::lonnet::coursedescription($course);
                         $coursedesc = $courseinfo{'description'};                          $coursedesc = $courseinfo{'description'};
                     }                      }
                     $category = "Group files in the course '$coursedesc'";                      $category = "Group portfolio files in the course '$coursedesc'";
                 } else {                  } else {
                     $category = 'Portfolio files belonging to ';                      $category = 'Portfolio files belonging to ';
                     if ($env{'user.name'} eq 'public' &&                       if ($env{'user.name'} eq 'public' && 
Line 3241  sub blocking_status { Line 4025  sub blocking_status {
   
 ###############################################  ###############################################
   
   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
   
 =head1 Domain Template Functions  =head1 Domain Template Functions
Line 3260  sub determinedomain { Line 4098  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 3284  sub get_domainconf { Line 4122  sub get_domainconf {
   
     my %domconfig = &Apache::lonnet::get_dom('configuration',      my %domconfig = &Apache::lonnet::get_dom('configuration',
      ['login','rolecolors'],$udom);       ['login','rolecolors'],$udom);
     my %designhash;      my (%designhash,%legacy);
     if (keys(%domconfig) > 0) {      if (keys(%domconfig) > 0) {
         if (ref($domconfig{'login'}) eq 'HASH') {          if (ref($domconfig{'login'}) eq 'HASH') {
             foreach my $key (keys(%{$domconfig{'login'}})) {              if (keys(%{$domconfig{'login'}})) {
                 $designhash{$udom.'.login.'.$key}=$domconfig{'login'}{$key};                  foreach my $key (keys(%{$domconfig{'login'}})) {
                       if (ref($domconfig{'login'}{$key}) eq 'HASH') {
                           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 (ref($domconfig{'rolecolors'}) eq 'HASH') {
             foreach my $role (keys(%{$domconfig{'rolecolors'}})) {              if (keys(%{$domconfig{'rolecolors'}})) {
                 if (ref($domconfig{'rolecolors'}{$role}) eq 'HASH') {                  foreach my $role (keys(%{$domconfig{'rolecolors'}})) {
                     foreach my $item (keys(%{$domconfig{'rolecolors'}{$role}})) {                      if (ref($domconfig{'rolecolors'}{$role}) eq 'HASH') {
                         $designhash{$udom.'.'.$role.'.'.$item}=$domconfig{'rolecolors'}{$role}{$item};                          foreach my $item (keys(%{$domconfig{'rolecolors'}{$role}})) {
                               $designhash{$udom.'.'.$role.'.'.$item}=$domconfig{'rolecolors'}{$role}{$item};
                           }
                     }                      }
                 }                  }
               } else {
                   $legacy{'rolecolors'} = 1;
             }              }
           } else {
               $legacy{'rolecolors'} = 1;
         }          }
     } else {          if (keys(%legacy) > 0) {
         my $designdir=$Apache::lonnet::perlvar{'lonTabDir'}.'/lonDomColors';              my %legacyhash = &get_legacy_domconf($udom);
         my $designfile =  $designdir.'/'.$udom.'.tab';              foreach my $item (keys(%legacyhash)) {
         if (-e $designfile) {                  if ($item =~ /^\Q$udom\E\.login/) {
             if ( open (my $fh,"<$designfile") ) {                      if ($legacy{'login'}) { 
                 while (my $line = <$fh>) {                          $designhash{$item} = $legacyhash{$item};
                     next if ($line =~ /^\#/);                      }
                     chomp($line);                  } else {
                     my ($key,$val)=(split(/\=/,$line));                      if ($legacy{'rolecolors'}) {
                     if ($val) { $designhash{$udom.'.'.$key}=$val; }                          $designhash{$item} = $legacyhash{$item};
                       }
                 }                  }
                 close($fh);  
             }              }
         }          }
         if (-e '/home/httpd/html/adm/lonDomLogos/'.$udom.'.gif') {      } else {
             $designhash{$udom.'.login.domlogo'} = "/adm/lonDomLogos/$udom.gif";          %designhash = &get_legacy_domconf($udom); 
         }  
     }      }
     &Apache::lonnet::do_cache_new('domainconfig',$udom,\%designhash,      &Apache::lonnet::do_cache_new('domainconfig',$udom,\%designhash,
   $cachetime);    $cachetime);
     return %designhash;      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 3372  Returns: value of designparamter $which Line 4250  Returns: value of designparamter $which
 sub designparm {  sub designparm {
     my ($which,$domain)=@_;      my ($which,$domain)=@_;
     if ($env{'browser.blackwhite'} eq 'on') {      if ($env{'browser.blackwhite'} eq 'on') {
  if ($which=~/\.(font|alink|vlink|link)$/) {   if ($which=~/\.(font|alink|vlink|link|textcol)$/) {
     return '#000000';      return '#000000';
  }   }
  if ($which=~/\.(pgbg|sidebg)$/) {   if ($which=~/\.(pgbg|sidebg|bgcol)$/) {
     return '#FFFFFF';      return '#FFFFFF';
  }   }
  if ($which=~/\.tabbg$/) {   if ($which=~/\.tabbg$/) {
Line 3394  sub designparm { Line 4272  sub designparm {
         $output = $defaultdesign{$which};          $output = $defaultdesign{$which};
     }      }
     if (($which =~ /^(student|coordinator|author|admin)\.img$/) ||      if (($which =~ /^(student|coordinator|author|admin)\.img$/) ||
         ($which =~ /login\.(img|logo|domlogo)/)) {          ($which =~ /login\.(img|logo|domlogo|login)/)) {
         if ($output =~ m{^/(adm|res)/}) {          if ($output =~ m{^/(adm|res)/}) {
     if ($output =~ m{^/res/}) {      if ($output =~ m{^/res/}) {
  my $local_name = &Apache::lonnet::filelocation('',$output);   my $local_name = &Apache::lonnet::filelocation('',$output);
Line 3478  sub bodytag { Line 4356  sub bodytag {
     my $font =   &designparm($function.'.font',$domain);      my $font =   &designparm($function.'.font',$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),
Line 3505  sub bodytag { Line 4383  sub bodytag {
     if (!$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,\%design);      my $extra_body_attr = &make_attr_string($forcereg,\%design);
   
Line 3565  ENDROLE Line 4440  ENDROLE
         $dc_info = '('.$dc_info.')';          $dc_info = '('.$dc_info.')';
     }      }
   
     if ($env{'environment.remote'} eq 'off') {      if (($env{'environment.remote'} eq 'off') || ($args->{'suppress_header_logos'})) {
         # No Remote          # No Remote
  if ($env{'request.state'} eq 'construct') {   if ($env{'request.state'} eq 'construct') {
     $forcereg=1;      $forcereg=1;
Line 3588  ENDROLE Line 4463  ENDROLE
  $lastitem = $thisdisfn;   $lastitem = $thisdisfn;
     }      }
     $titleinfo =       $titleinfo = 
  &Apache::loncommon::help_open_menu('','',3,'Authoring').   &Apache::loncommon::help_open_menu('','',3,'Authoring')
  '<b>Construction Space</b>:&nbsp;'.    .'<b>'.&mt('Construction Space').'</b>:&nbsp;'
  '<form name="dirs" method="post" action="'.$formaction   .'<form name="dirs" method="post" action="'.$formaction
  .'" target="_top"><tt><b>'   .'" target="_top"><tt><b>'
  .&Apache::lonhtmlcommon::crumbs($uname.'/'.$parentpath,'_top','/priv','','+1',1)."<font size=\"+1\">$lastitem</font></b></tt><br />"   .&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()')   .&Apache::lonhtmlcommon::select_recent('construct','recent','this.form.action=this.form.recent.value;this.form.submit()')
Line 3625  ENDROLE Line 4500  ENDROLE
   
     my $imgsrc = $img;      my $imgsrc = $img;
     if ($img =~ /^\/adm/) {      if ($img =~ /^\/adm/) {
         $imgsrc = 'http://'.$ENV{'HTTP_HOST'}.':'.$lonhttpdPort.$img;          $imgsrc = &lonhttpdurl($img);
     }      }
     my $upperleft='<img src="'.$imgsrc.'" alt="'.$function.'" />';      my $upperleft='<img src="'.$imgsrc.'" alt="'.$function.'" />';
   
Line 3714  sub make_attr_string { Line 4589  sub make_attr_string {
   
 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,
   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;
 }  }
Line 3759  sub standard_css { Line 4641  sub standard_css {
     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 $mono                 = 'monospace';      my $mono                 = 'monospace';
     my $data_table_head      = $tabbg;      my $data_table_head      = $tabbg;
     my $data_table_light     = '#EEEEEE';      my $data_table_light     = '#FAFAFA';
     my $data_table_dark      = '#DDDDDD';      my $data_table_dark      = '#F0F0F0';
     my $data_table_darker    = '#CCCCCC';      my $data_table_darker    = '#CCCCCC';
     my $data_table_highlight = '#FFFF00';      my $data_table_highlight = '#FFFF00';
     my $mail_new             = '#FFBB77';      my $mail_new             = '#FFBB77';
Line 3776  sub standard_css { Line 4658  sub standard_css {
     my $mail_other_hover     = '#669999';      my $mail_other_hover     = '#669999';
     my $table_header         = '#DDDDDD';      my $table_header         = '#DDDDDD';
     my $feedback_link_bg     = '#BBBBBB';      my $feedback_link_bg     = '#BBBBBB';
       my $lg_border_color      = '#C8C8C8';
   
     my $border = ($env{'browser.type'} eq 'explorer') ? '0px 2px 0px 2px'      my $border = ($env{'browser.type'} eq 'explorer' ||
                                               : '0px 3px 0px 4px';    $env{'browser.type'} eq 'safari'     ) ? '0 2px 0 2px'
                                                    : '0 3px 0 4px';
   
   
     return <<END;      return <<END;
 h1, h2, h3, th { font-family: $sans }  h1, h2, h3, th { font-family: $sans }
 a:focus { color: red; background: yellow }   a:focus { color: red; background: yellow } 
   
   hr {
     clear: both;
     color: $tabbg;
     background-color: $tabbg;
     height: 3px;
     border: none;
   }
   
 table.thinborder,  table.thinborder,
   
 table.thinborder tr th {  table.thinborder tr th {
Line 3798  table.thinborder tr td { Line 4691  table.thinborder tr td {
   
 form, .inline { display: inline; }  form, .inline { display: inline; }
 .center { text-align: center; }  .center { text-align: center; }
 .LC_filename {font-family: $mono;}  .LC_filename {font-family: $mono; white-space:pre;}
 .LC_error {  .LC_error {
   color: red;    color: red;
   font-size: larger;    font-size: larger;
Line 3813  form, .inline { display: inline; } Line 4706  form, .inline { display: inline; }
 .LC_diff_added {  .LC_diff_added {
   color: green;    color: green;
 }  }
 .LC_unknown {  
   color: yellow;  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 {  .LC_icon {
   border: 0px;    border: none;
 }  }
 .LC_indexer_icon {  .LC_indexer_icon {
   border: 0px;    border: 0;
   height: 22px;    height: 22px;
 }  }
 .LC_docs_spacer {  .LC_docs_spacer {
   width: 25px;    width: 25px;
   height: 1px;    height: 1px;
   border: 0px;    border: none;
 }  }
   
 .LC_internal_info {  .LC_internal_info {
   color: #999;    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 {  table.LC_pastsubmission {
Line 3839  table.LC_pastsubmission { Line 4773  table.LC_pastsubmission {
   margin: 2px;    margin: 2px;
 }  }
   
 table#LC_top_nav, table#LC_menubuttons {  table#LC_top_nav, table#LC_menubuttons,table#LC_nav_location {
   width: 100%;    width: 100%;
   background: $pgbg;    background: $pgbg;
   border: 2px;    border: 2px;
   border-collapse: separate;    border-collapse: separate;
   padding: 0px;    padding: 0;
 }  }
   
 table#LC_title_bar, table.LC_breadcrumbs, table#LC_nav_location,  table#LC_title_bar, table.LC_breadcrumbs, 
 table#LC_title_bar.LC_with_remote {  table#LC_title_bar.LC_with_remote {
   width: 100%;    width: 100%;
   border-color: $pgbg;    border-color: $pgbg;
Line 3857  table#LC_title_bar.LC_with_remote { Line 4791  table#LC_title_bar.LC_with_remote {
   background: $pgbg;    background: $pgbg;
   font-family: $sans;    font-family: $sans;
   border-collapse: collapse;    border-collapse: collapse;
   padding: 0px;    padding: 0;
 }  }
   
 table.LC_docs_path {  table.LC_docs_path {
Line 3866  table.LC_docs_path { Line 4800  table.LC_docs_path {
   background: $pgbg;    background: $pgbg;
   font-family: $sans;    font-family: $sans;
   border-collapse: collapse;    border-collapse: collapse;
   padding: 0px;    padding: 0;
 }  }
   
 table#LC_title_bar td {  table#LC_title_bar td {
Line 3887  span.LC_title_bar_title { Line 4821  span.LC_title_bar_title {
 table#LC_title_bar td.LC_title_bar_domain_logo {  table#LC_title_bar td.LC_title_bar_domain_logo {
   background: $sidebg;    background: $sidebg;
   text-align: right;    text-align: right;
   padding: 0px;    padding: 0;
 }  }
 table#LC_title_bar td.LC_title_bar_role_logo {  table#LC_title_bar td.LC_title_bar_role_logo {
   background: $sidebg;    background: $sidebg;
   padding: 0px;    padding: 0;
 }  }
   
 table#LC_menubuttons_mainmenu {  table#LC_menubuttons_mainmenu {
   width: 100%;    width: 100%;
   border: 0px;    border: 0;
   border-spacing: 1px;    border-spacing: 1px;
   padding: 0px 1px;    padding: 0 1px;
   margin: 0px;    margin: 0;
   border-collapse: separate;    border-collapse: separate;
 }  }
 table#LC_menubuttons img, table#LC_menubuttons_mainmenu img {  table#LC_menubuttons img, table#LC_menubuttons_mainmenu img {
   border: 0px;    border: none;
 }  }
 table#LC_top_nav td {  table#LC_top_nav td {
   background: $tabbg;    background: $tabbg;
   border: 0px;    border: none;
   font-size: small;    font-size: small;
 }  }
 table#LC_top_nav td a, div#LC_top_nav a {  table#LC_top_nav td a, div#LC_top_nav a {
Line 3921  table#LC_top_nav td.LC_top_nav_logo { Line 4855  table#LC_top_nav td.LC_top_nav_logo {
   width: 31px;    width: 31px;
 }  }
 table#LC_top_nav td.LC_top_nav_logo img {  table#LC_top_nav td.LC_top_nav_logo img {
   border: 0px;    border: none;
   vertical-align: bottom;    vertical-align: bottom;
 }  }
 table#LC_top_nav td.LC_top_nav_exit,  table#LC_top_nav td.LC_top_nav_exit,
Line 3949  table.LC_docs_path td.LC_docs_path_compo Line 4883  table.LC_docs_path td.LC_docs_path_compo
 td.LC_table_cell_checkbox {  td.LC_table_cell_checkbox {
   text-align: center;    text-align: center;
 }  }
   
 table#LC_mainmenu td.LC_mainmenu_column {  table#LC_mainmenu td.LC_mainmenu_column {
     vertical-align: top;      vertical-align: top;
 }  }
Line 3963  table#LC_mainmenu td.LC_mainmenu_column Line 4896  table#LC_mainmenu td.LC_mainmenu_column
 .LC_menubuttons_link {  .LC_menubuttons_link {
   text-decoration: none;    text-decoration: none;
 }  }
   /*2008--9-5: new menu style sheet.Changed category*/
 .LC_menubuttons_category {  .LC_menubuttons_category {
   color: $font;    color: $font;
   background: $pgbg;    background: $pgbg;
Line 3987  td.LC_menubuttons_img { Line 4920  td.LC_menubuttons_img {
 }  }
 .LC_new_mail {  .LC_new_mail {
   font-family: $sans;    font-family: $sans;
     background: $tabbg;
   font-weight: bold;    font-weight: bold;
 }  }
   
 .LC_rolesmenu_is {  
   font-family: $sans;  
 }  
   
 .LC_rolesmenu_selected {  
   font-family: $sans;  
 }  
   
 .LC_rolesmenu_future {  
   font-family: $sans;  
 }  
   
   
 .LC_rolesmenu_will {  
   font-family: $sans;  
 }  
   
 .LC_rolesmenu_will_not {  
   font-family: $sans;  
 }  
   
 .LC_rolesmenu_expired {  
   font-family: $sans;  
 }  
   
 .LC_rolesinfo {  
   font-family: $sans;  
 }  
   
 .LC_dropadd_labeltext {  .LC_dropadd_labeltext {
   font-family: $sans;    font-family: $sans;
   text-align: right;    text-align: right;
Line 4029  td.LC_menubuttons_img { Line 4934  td.LC_menubuttons_img {
   text-align: right;    text-align: right;
 }  }
   
   .LC_roleslog_note {
     font-size: smaller;
   }
   
   .LC_mail_functions {
       font-weight: bold;
   }
   
 table.LC_aboutme_port {  table.LC_aboutme_port {
   border: 0px;    border: none;
   border-collapse: collapse;    border-collapse: collapse;
   border-spacing: 0px;    border-spacing: 0;
 }  }
 table.LC_data_table, table.LC_mail_list {  table.LC_data_table, table.LC_mail_list {
   border: 1px solid #000000;    border: 1px solid #000000;
   border-collapse: separate;    border-collapse: separate;
   border-spacing: 1px;    border-spacing: 1px;
     background: $pgbg;
 }  }
 .LC_data_table_dense {  .LC_data_table_dense {
   font-size: small;    font-size: small;
 }  }
 table.LC_nested_outer {  table.LC_nested_outer {
   border: 1px solid #000000;    border: 1px solid #000000;
   border-collapse: separate;    border-collapse: collapse;
   border-spacing: 0px;    border-spacing: 0;
   width: 100%;    width: 100%;
 }  }
   table.LC_innerpickbox,
 table.LC_nested {  table.LC_nested {
   border: 0px;    border: none;
   border-collapse: separate;    border-collapse: collapse;
   border-spacing: 0px;    border-spacing: 0;
   width: 100%;    width: 100%;
 }  }
 table.LC_data_table tr th, table.LC_calendar tr th, table.LC_mail_list tr th,  table.LC_data_table tr th, table.LC_calendar tr th, table.LC_mail_list tr th,
 table.LC_prior_tries 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;
   font-size: smaller;    font-size: smaller;
 }  }
 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, 
   table.LC_pick_box tr > td.LC_odd_row,
 table.LC_aboutme_port tr td {  table.LC_aboutme_port tr td {
   background-color: $data_table_light;    background-color: $data_table_light;
   padding: 2px;    padding: 2px;
 }  }
 table.LC_data_table tr.LC_even_row td,  table.LC_data_table tr.LC_even_row > td,
   table.LC_pick_box tr > td.LC_even_row,
 table.LC_aboutme_port tr.LC_even_row td {  table.LC_aboutme_port tr.LC_even_row td {
   background-color: $data_table_dark;    background-color: $data_table_dark;
     padding: 2px;
 }  }
 table.LC_data_table tr.LC_data_table_highlight td {  table.LC_data_table tr.LC_data_table_highlight td {
   background-color: $data_table_darker;    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_data_table tr.LC_empty_row td,
 table.LC_nested tr.LC_empty_row td {  table.LC_nested tr.LC_empty_row td {
   background-color: #FFFFFF;    background-color: #FFFFFF;
Line 4097  table.LC_nested_outer tr td.LC_subheader Line 5029  table.LC_nested_outer tr td.LC_subheader
   text-align: right;    text-align: right;
 }  }
 table.LC_nested tr.LC_info_row td {  table.LC_nested tr.LC_info_row td {
   background-color: #CCC;    background-color: #CCCCCC;
   font-weight: bold;    font-weight: bold;
   font-size: small;    font-size: small;
   text-align: center;    text-align: center;
 }  }
 table.LC_nested tr.LC_info_row td.LC_left_item {  table.LC_nested tr.LC_info_row td.LC_left_item,
   table.LC_nested_outer tr th.LC_left_item {
   text-align: left;    text-align: left;
 }  }
 table.LC_nested td {  table.LC_nested td {
   background-color: #FFF;    background-color: #FFFFFF;
   font-size: small;    font-size: small;
 }  }
 table.LC_nested_outer tr th.LC_right_item,  table.LC_nested_outer tr th.LC_right_item,
Line 4117  table.LC_nested tr td.LC_right_item { Line 5050  table.LC_nested tr td.LC_right_item {
 }  }
   
 table.LC_nested tr.LC_odd_row td {  table.LC_nested tr.LC_odd_row td {
   background-color: #EEE;    background-color: #EEEEEE;
 }  }
   
 table.LC_createuser {  table.LC_createuser {
Line 4128  table.LC_createuser tr.LC_section_row td Line 5061  table.LC_createuser tr.LC_section_row td
 }  }
   
 table.LC_createuser tr.LC_info_row td  {  table.LC_createuser tr.LC_info_row td  {
   background-color: #CCC;    background-color: #CCCCCC;
   font-weight: bold;    font-weight: bold;
   text-align: center;    text-align: center;
 }  }
Line 4184  table.LC_mail_list tr.LC_mail_odd { Line 5117  table.LC_mail_list tr.LC_mail_odd {
 table#LC_portfolio_actions {  table#LC_portfolio_actions {
   width: auto;    width: auto;
   background: $pgbg;    background: $pgbg;
   border: 0px;    border: none;
   border-spacing: 2px 2px;    border-spacing: 2px 2px;
   padding: 0px;    padding: 0;
   margin: 0px;    margin: 0;
   border-collapse: separate;    border-collapse: separate;
 }  }
 table#LC_portfolio_actions td.LC_label {  table#LC_portfolio_actions td.LC_label {
Line 4243  table#LC_browser tr.LC_browser_file_meta Line 5176  table#LC_browser tr.LC_browser_file_meta
 table#LC_browser tr.LC_browser_folder {  table#LC_browser tr.LC_browser_folder {
   background: #CCCCFF;    background: #CCCCFF;
 }  }
   
   table.LC_data_table tr > td.LC_roles_is {
   /*  background: #77FF77; */
   }
   table.LC_data_table tr > td.LC_roles_future {
     background: #FFFF77;
   }
   table.LC_data_table tr > td.LC_roles_will {
     background: #FFAA77;
   }
   table.LC_data_table tr > td.LC_roles_expired {
     background: #FF7777;
   }
   table.LC_data_table tr > td.LC_roles_will_not {
     background: #AAFF77;
   }
   table.LC_data_table tr > td.LC_roles_selected {
     background: #11CC55;
   }
   
 span.LC_current_location {  span.LC_current_location {
   font-size: x-large;    font-size: x-large;
   background: $pgbg;    background: $pgbg;
Line 4288  table.LC_parm_overview_restrictions th { Line 5241  table.LC_parm_overview_restrictions th {
   border-color: $pgbg;    border-color: $pgbg;
 }  }
 table#LC_helpmenu {  table#LC_helpmenu {
   border: 0px;    border: none;
   height: 55px;    height: 55px;
   border-spacing: 0px;    border-spacing: 0;
 }  }
   
 table#LC_helpmenu fieldset legend {  table#LC_helpmenu fieldset legend {
Line 4301  table#LC_helpmenu_links { Line 5254  table#LC_helpmenu_links {
   width: 100%;    width: 100%;
   border: 1px solid black;    border: 1px solid black;
   background: $pgbg;    background: $pgbg;
   padding: 0px;    padding: 0;
   border-spacing: 1px;    border-spacing: 1px;
 }  }
 table#LC_helpmenu_links tr td {  table#LC_helpmenu_links tr td {
Line 4333  table#LC_helpmenu_links a:hover { Line 5286  table#LC_helpmenu_links a:hover {
   border: 1px solid #8888FF;    border: 1px solid #8888FF;
   background: #CCCCFF;    background: #CCCCFF;
 }  }
   
 table.LC_pick_box {  table.LC_pick_box {
   width: 100%;  
   border-collapse: separate;    border-collapse: separate;
   background: white;    background: white;
   border: 1px solid black;    border: 1px solid black;
Line 4345  table.LC_pick_box td.LC_pick_box_title { Line 5296  table.LC_pick_box td.LC_pick_box_title {
   background: $tabbg;    background: $tabbg;
   font-weight: bold;    font-weight: bold;
   text-align: right;    text-align: right;
     vertical-align: top;
   width: 184px;    width: 184px;
   padding: 8px;    padding: 8px;
 }  }
   table.LC_pick_box td.LC_selfenroll_pick_box_title {
     background: $tabbg;
     font-weight: bold;
     text-align: right;
     width: 350px;
     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 {  table.LC_pick_box td.LC_pick_box_separator {
   padding: 0px;    padding: 0;
   height: 1px;    height: 1px;
   background: black;    background: black;
 }  }
 table.LC_pick_box td.LC_pick_box_submit {  table.LC_pick_box td.LC_pick_box_submit {
   text-align: right;    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;
   }
   table.LC_helpform_receipt {
     width: 620px;
     border-collapse: separate;
     background: white;
     border: 1px solid black;
     border-spacing: 1px;
   }
   table.LC_helpform_receipt td.LC_pick_box_title {
     background: $tabbg;
     font-weight: bold;
     text-align: right;
     width: 184px;
     padding: 8px;
   }
   table.LC_helpform_receipt td.LC_evenrow_value {
     text-align: left;
     padding: 8px;
     background-color: $data_table_light;
   }
   table.LC_helpform_receipt td.LC_oddrow_value {
     text-align: left;
     padding: 8px;
     background-color: $data_table_light;
   }
   table.LC_helpform_receipt td.LC_pick_box_separator {
     padding: 0;
     height: 1px;
     background: black;
   }
   span.LC_helpform_receipt_cat {
     font-weight: bold;
   }
 table.LC_group_priv_box {  table.LC_group_priv_box {
   background: white;    background: white;
   border: 1px solid black;    border: 1px solid black;
Line 4383  table.LC_group_priv_box td.LC_groups_fun Line 5392  table.LC_group_priv_box td.LC_groups_fun
 }  }
 table.LC_group_priv td {  table.LC_group_priv td {
   text-align: left;    text-align: left;
   padding: 0px;    padding: 0;
 }  }
   
 table.LC_notify_front_page {  table.LC_notify_front_page {
Line 4404  table.LC_notify_front_page td { Line 5413  table.LC_notify_front_page td {
   background: $tabbg;    background: $tabbg;
   vertical-align: middle;    vertical-align: middle;
   margin: 2ex 0ex 2ex 0ex;    margin: 2ex 0ex 2ex 0ex;
     padding: 3px;
 }  }
 .LC_topic_bar span {  .LC_topic_bar span {
   vertical-align: middle;    vertical-align: middle;
Line 4424  table.LC_descriptive_input td.LC_descrip Line 5434  table.LC_descriptive_input td.LC_descrip
   text-align: right;    text-align: right;
   font-weight: bold;    font-weight: bold;
 }  }
 table.LC_feedback_link {  div.LC_feedback_link {
     background: $feedback_link_bg;    clear: both;
     background: white;
     width: 100%;  
 }  }
 span.LC_feedback_link {  span.LC_feedback_link {
     background: $feedback_link_bg;    background: $feedback_link_bg;
     font-size: larger;    font-size: larger;
   }
   span.LC_message_link {
     background: $feedback_link_bg;
     font-size: larger;
     position: absolute;
     right: 1em;
 }  }
   
 table.LC_prior_tries {  table.LC_prior_tries {
Line 4501  span.LC_nobreak { Line 5519  span.LC_nobreak {
   white-space: nowrap;    white-space: nowrap;
 }  }
   
   span.LC_cusr_emph {
     font-style: italic;
   }
   
   span.LC_cusr_subheading {
     font-weight: normal;
     font-size: 85%;
   }
   
 table.LC_docs_documents {  table.LC_docs_documents {
   background: #BBBBBB;    background: #BBBBBB;
   border-width: 0px;    border-width: 0;
   border-collapse: collapse;    border-collapse: collapse;
 }  }
   
Line 4520  table.LC_docs_documents td.LC_docs_docum Line 5547  table.LC_docs_documents td.LC_docs_docum
 }  }
   
 .LC_docs_entry_move {  .LC_docs_entry_move {
   border: 0px;    border: none;
   border-collapse: collapse;    border-collapse: collapse;
 }  }
   
Line 4568  table.LC_docs_adddocs th { Line 5595  table.LC_docs_adddocs th {
   background: #DDDDDD;    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;
   }
   
   span.LC_role_level {
     font-weight: bold;
   }
   
   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_select_mode {
     font-family: $sans;
   }
   div.LC_grade_select_mode div div {
     margin: 5px;
   }
   div.LC_grade_select_mode_selector {
     margin: 5px;
     float: left;
   }
   div.LC_grade_select_mode_selector_header {
     font: bold medium $sans;
   }
   div.LC_grade_select_mode_type {
     clear: left;
   }
   
   div.LC_grade_show_user {
     margin-top: 20px;
     border: 1px solid black;
   }
   div.LC_grade_user_name {
     background: #DDDDEE;
     border-bottom: 1px solid black;
     font: bold large $sans;
   }
   div.LC_grade_show_user_odd_row div.LC_grade_user_name {
     background: #DDEEDD;
   }
   
   div.LC_grade_show_problem,
   div.LC_grade_submissions,
   div.LC_grade_message_center,
   div.LC_grade_info_links,
   div.LC_grade_assign {
     margin: 5px;
     width: 99%;
     background: #FFFFFF;
   }
   div.LC_grade_show_problem_header,
   div.LC_grade_submissions_header,
   div.LC_grade_message_center_header,
   div.LC_grade_assign_header {
     font: bold large $sans;
   }
   div.LC_grade_show_problem_problem,
   div.LC_grade_submissions_body,
   div.LC_grade_message_center_body,
   div.LC_grade_assign_body {
     border: 1px solid black;
     width: 99%;
     background: #FFFFFF;
   }
   span.LC_grade_check_note {
     font: normal medium $sans;
     display: inline;
     position: absolute;
     right: 1em;
   }
   
   table.LC_scantron_action {
     width: 100%;
   }
   table.LC_scantron_action tr th {
     font: normal bold $sans;
   }
   
   div.LC_edit_problem_header, 
   div.LC_edit_problem_footer {
     font: normal medium $sans;
     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_edit_row {
     background: $tabbg;
     padding: 3px;
     margin-bottom: 5px;
   }
   div.LC_edit_problem_header_title {
     font: larger bold $sans;
     background: $tabbg;
     padding: 3px;
   }
   table.LC_edit_problem_header_title {
     font: larger bold $sans;
     width: 100%;
     border-color: $pgbg;
     border-style: solid;
     border-width: $border;
   
     background: $tabbg;
     border-collapse: collapse;
     padding: 0;
   }
   
   div.LC_edit_problem_discards {
     float: left;
     padding-bottom: 5px;
   }
   div.LC_edit_problem_saves {
     float: right;
     padding-bottom: 5px;
   }
   hr.LC_edit_problem_divide {
     clear: both;
     color: $tabbg;
     background-color: $tabbg;
     height: 3px;
     border: none;
   }
   img.stift{
     border-width:0;
     vertical-align:middle;
   }
   
   table#LC_mainmenu{
    margin-top:10px;
    width:80%;
   
   }
   
   table#LC_mainmenu td.LC_mainmenu_col_fieldset{
     vertical-align: top;
     width: 45%;
   }
   .LC_mainmenu_fieldset_category {
     color: $font;
     background: $pgbg;
     font-family: $sans;
     font-size: small;
     font-weight: bold;
   }
   fieldset#LC_mainmenu_fieldset {
     margin:0 10px 10px 0;
   
   }
   
   div.LC_createcourse {
       margin: 10px 10px 10px 10px;
   }
   
 END  END
 }  }
   
Line 4661  Inputs: none Line 5884  Inputs: none
   
 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 4684  Inputs: none Line 5904  Inputs: none
 sub xml_begin {  sub xml_begin {
     my $output='';      my $output='';
   
     &Apache::lonhtmlcommon::init_htmlareafields();      if ($env{'internal.start_page'}==1) {
    &Apache::lonhtmlcommon::init_htmlareafields();
       }
   
     if ($env{'browser.mathml'}) {      if ($env{'browser.mathml'}) {
  $output='<?xml version="1.0"?>'   $output='<?xml version="1.0"?>'
Line 4696  sub xml_begin { Line 5918  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;
 }  }
Line 4721  sub endheadtag { Line 5944  sub endheadtag {
   
 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
   
 =cut  =cut
   
Line 4737  sub head { Line 5967  sub head {
   
 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() notopbar 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               body_title     -> alternate text to use instead of $title
                                     in the title box that appears, this text                                      in the title box that appears, this text
                                     is not auto translated like the $title is                                      is not auto translated like the $title is
                   frameset       -> if true will start with a <frameset>               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               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 
                   no_inline_link -> if true and in remote mode, don't show the   
                                     'Switch To Inline Menu' link                                      'Switch To Inline Menu' link
                no_auto_mt_title -> prevent &mt()ing the title arg
                   no_auto_mt_title -> prevent &mt()ing the title arg               inherit_jsmath -> when creating popup window in a page,
   
                   inherit_jsmath -> when creating popup window in a page,  
                                     should it have jsmath forced on by the                                      should it have jsmath forced on by the
                                     current page                                      current page
   
   =back
   
   =back
   
 =cut  =cut
   
 sub start_page {  sub start_page {
Line 4820  sub start_page { Line 6060  sub start_page {
     if ($args->{'html_encode'}) {      if ($args->{'html_encode'}) {
  $result = &html_encode($result);   $result = &html_encode($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;
 }  }
   
   
 =pod  =pod
   
 =item * &head()  =item * &head()
Line 4861  sub end_page { Line 6117  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 4933  sub simple_error_page { Line 6189  sub simple_error_page {
 }  }
   
 {  {
     my $row_count;      my @row_count;
     sub start_data_table {      sub start_data_table {
  my ($add_class) = @_;   my ($add_class) = @_;
  my $css_class = (join(' ','LC_data_table',$add_class));   my $css_class = (join(' ','LC_data_table',$add_class));
  undef($row_count);   unshift(@row_count,0);
  return '<table class="'.$css_class.'">'."\n";   return '<table class="'.$css_class.'">'."\n";
     }      }
   
     sub end_data_table {      sub end_data_table {
  undef($row_count);   shift(@row_count);
  return '</table>'."\n";;   return '</table>'."\n";;
     }      }
   
     sub start_data_table_row {      sub start_data_table_row {
  my ($add_class) = @_;   my ($add_class) = @_;
  $row_count++;   $row_count[0]++;
  my $css_class = ($row_count % 2)?'':'LC_even_row';   my $css_class = ($row_count[0] % 2)?'LC_odd_row':'LC_even_row';
  $css_class = (join(' ',$css_class,$add_class));   $css_class = (join(' ',$css_class,$add_class));
  return  '<tr class="'.$css_class.'">'."\n";;   return  '<tr class="'.$css_class.'">'."\n";;
     }      }
           
     sub continue_data_table_row {      sub continue_data_table_row {
  my ($add_class) = @_;   my ($add_class) = @_;
  my $css_class = ($row_count % 2)?'':'LC_even_row';   my $css_class = ($row_count[0] % 2)?'LC_odd_row':'LC_even_row';
  $css_class = (join(' ',$css_class,$add_class));   $css_class = (join(' ',$css_class,$add_class));
  return  '<tr class="'.$css_class.'">'."\n";;   return  '<tr class="'.$css_class.'">'."\n";;
     }      }
Line 4966  sub simple_error_page { Line 6222  sub simple_error_page {
     }      }
   
     sub start_data_table_empty_row {      sub start_data_table_empty_row {
  $row_count++;   $row_count[0]++;
  return  '<tr class="LC_empty_row" >'."\n";;   return  '<tr class="LC_empty_row" >'."\n";;
     }      }
   
Line 5054  sub get_users_function { Line 6310  sub get_users_function {
     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 5065  sub get_users_function { Line 6321  sub get_users_function {
   
 =pod  =pod
   
   =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()  =item * &check_user_status()
   
 Determines current status of supplied role for a  Determines current status of supplied role for a
Line 5238  previous, future, or all. Line 6525  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.
   
Line 5252  of the possibility of multiple values fo Line 6544  of the possibility of multiple values fo
 ###############################################  ###############################################
   
 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;      my %seclists;
   
Line 5272  sub get_course_users { Line 6564  sub get_course_users {
             my $match = 0;              my $match = 0;
             my $secmatch = 0;              my $secmatch = 0;
             my $section = $$classlist{$student}[$idx{section}];              my $section = $$classlist{$student}[$idx{section}];
               my $status = $$classlist{$student}[$idx{status}];
             if ($section eq '') {              if ($section eq '') {
                 $section = 'none';                  $section = 'none';
             }              }
Line 5291  sub get_course_users { Line 6584  sub get_course_users {
                     next;                      next;
                 }                  }
             }              }
             push(@{$seclists{$student}},$section);   
             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 5299  sub get_course_users { Line 6591  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 && ref($userdata) eq 'HASH') {              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} > 1) || ((@{$roles} == 1) && ($$roles[0] ne "st"))) {      if ((@{$roles} > 1) || ((@{$roles} == 1) && ($$roles[0] ne "st"))) {
         my %coursepersonnel = &Apache::lonnet::dump('nohist_userroles',$cdom,$cnum);          my %coursepersonnel = &Apache::lonnet::dump('nohist_userroles',$cdom,$cnum);
         my $now = time;          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))) {          foreach my $person (sort(keys(%coursepersonnel))) {
             my $match = 0;              my $match = 0;
             my $secmatch = 0;              my $secmatch = 0;
Line 5351  sub get_course_users { Line 6664  sub get_course_users {
                     $usec = 'none';                      $usec = 'none';
                 }                  }
                 if ($uname ne '' && $udom ne '') {                  if ($uname ne '' && $udom ne '') {
                       if ($hidepriv) {
                           if ((&Apache::lonnet::privileged($uname,$udom)) &&
                               (!$nothide{$uname.':'.$udom})) {
                               next;
                           }
                       }
                     if ($end > 0 && $end < $now) {                      if ($end > 0 && $end < $now) {
                         $status = 'previous';                          $status = 'previous';
                     } elsif ($start > $now) {                      } elsif ($start > $now) {
Line 5373  sub get_course_users { Line 6692  sub get_course_users {
                         if (!grep(/^\Q$usec\E$/,@{$seclists{$uname.':'.$udom}})) {                          if (!grep(/^\Q$usec\E$/,@{$seclists{$uname.':'.$udom}})) {
                             push(@{$seclists{$uname.':'.$udom}},$usec);                              push(@{$seclists{$uname.':'.$udom}},$usec);
                         }                          }
                           if (ref($statushash) eq 'HASH') {
                               $statushash->{$uname.':'.$udom}{$role}{$usec} = $displaystatus{$status};
                           }
                     }                      }
                 }                  }
             }              }
Line 5382  sub get_course_users { Line 6704  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'};
                     if ($owner !~ /^[^:]+:[^:]+$/) {                      next if ($owner eq '');
                         $owner = $owner.':'.$cdom;                      my ($ownername,$ownerdom);
                       if ($owner =~ /^([^:]+):([^:]+)$/) {
                           $ownername = $1;
                           $ownerdom = $2;
                       } else {
                           $ownername = $owner;
                           $ownerdom = $cdom;
                           $owner = $ownername.':'.$ownerdom;
                     }                      }
                     @{$$users{'ow'}{$owner}} = 'any';                      @{$$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.':'.$cdom}})) {                          if (!grep(/^none$/,@{$seclists{$owner}})) {
                             push(@{$seclists{$owner.':'.$cdom}},'none');                              push(@{$seclists{$owner}},'none');
                           }
                           if (ref($statushash) eq 'HASH') {
                               $statushash->{$owner}{'ow'}{'none'} = 'Any';
                         }                          }
     }      }
                 }                  }
Line 5410  sub get_user_info { Line 6742  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;      return;
 }  }
   
Line 5521  If the user's status includes multiple t Line 6855  If the user's status includes multiple t
 the largest default quota which applies to the user determines the  the largest default quota which applies to the user determines the
 default quota returned.  default quota returned.
   
   =back
   
 =cut  =cut
   
 ###############################################  ###############################################
Line 5530  sub default_quota { Line 6866  sub default_quota {
     my ($udom,$inststatus) = @_;      my ($udom,$inststatus) = @_;
     my ($defquota,$settingstatus);      my ($defquota,$settingstatus);
     my %quotahash = &Apache::lonnet::get_dom('configuration',      my %quotahash = &Apache::lonnet::get_dom('configuration',
                                             ['quota'],$udom);                                              ['quotas'],$udom);
     if (ref($quotahash{'quota'}) eq 'HASH') {      if (ref($quotahash{'quotas'}) eq 'HASH') {
         if ($inststatus ne '') {          if ($inststatus ne '') {
             my @statuses = split(/:/,$inststatus);              my @statuses = map { &unescape($_); } split(/:/,$inststatus);
             foreach my $item (@statuses) {              foreach my $item (@statuses) {
                 if ($quotahash{'quota'}{$item} ne '') {                  if (ref($quotahash{'quotas'}{'defaultquota'}) eq 'HASH') {
                     if ($defquota eq '') {                      if ($quotahash{'quotas'}{'defaultquota'}{$item} ne '') {
                         $defquota = $quotahash{'quota'}{$item};                          if ($defquota eq '') {
                         $settingstatus = $item;                              $defquota = $quotahash{'quotas'}{'defaultquota'}{$item};
                     } elsif ($quotahash{'quota'}{$item} > $defquota) {                              $settingstatus = $item;
                         $defquota = $quotahash{'quota'}{$item};                          } elsif ($quotahash{'quotas'}{'defaultquota'}{$item} > $defquota) {
                         $settingstatus = $item;                              $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 ($defquota eq '') {
             $defquota = $quotahash{'quota'}{'default'};              if (ref($quotahash{'quotas'}{'defaultquota'}) eq 'HASH') {
                   $defquota = $quotahash{'quotas'}{'defaultquota'}{'default'};
               } else {
                   $defquota = $quotahash{'quotas'}{'default'};
               }
             $settingstatus = 'default';              $settingstatus = 'default';
         }          }
     } else {      } else {
Line 5599  sub get_secgrprole_info { Line 6951  sub get_secgrprole_info {
 }  }
   
 sub user_picker {  sub user_picker {
     my ($dom,$srch,$forcenewuser,$caller) = @_;      my ($dom,$srch,$forcenewuser,$caller,$cancreate,$usertype) = @_;
     my $currdom = $dom;      my $currdom = $dom;
     my %curr_selected = (      my %curr_selected = (
                         srchin => 'dom',                          srchin => 'dom',
                         srchby => 'uname',                          srchby => 'lastname',
                       );                        );
     my $srchterm;      my $srchterm;
     if (ref($srch) eq 'HASH') {      if ((ref($srch) eq 'HASH') && ($env{'form.origform'} ne 'crtusername')) {
         if ($srch->{'srchby'} ne '') {          if ($srch->{'srchby'} ne '') {
             $curr_selected{'srchby'} = $srch->{'srchby'};              $curr_selected{'srchby'} = $srch->{'srchby'};
         }          }
Line 5622  sub user_picker { Line 6974  sub user_picker {
         $srchterm = $srch->{'srchterm'};          $srchterm = $srch->{'srchterm'};
     }      }
     my %lt=&Apache::lonlocal::texthash(      my %lt=&Apache::lonlocal::texthash(
                       'usr'       => 'Search criteria',
                     'doma'      => 'Domain/institution to search',                      'doma'      => 'Domain/institution to search',
                     'uname'     => 'username',                      'uname'     => 'username',
                     'lastname'  => 'last name',                      'lastname'  => 'last name',
                     'lastfirst' => 'last name, first name',                      'lastfirst' => 'last name, first name',
                     'crs'       => 'in this course',                      'crs'       => 'in this course',
                     'dom'       => 'in this domain',                       'dom'       => 'in selected LON-CAPA domain', 
                     'alc'       => 'all LON-CAPA',                      'alc'       => 'all LON-CAPA',
                     'instd'     => 'in institutional directory',                      'instd'     => 'in institutional directory for selected domain',
                     'exact'     => 'is',                      'exact'     => 'is',
                     'contains'  => 'contains',                      'contains'  => 'contains',
                     'begins'    => 'begins with',                      'begins'    => 'begins with',
Line 5652  sub user_picker { Line 7005  sub user_picker {
         #       loncreateuser::print_user_query_page()          #       loncreateuser::print_user_query_page()
         #       has been completed.          #       has been completed.
         next if ($option eq 'alc');          next if ($option eq 'alc');
           next if (($option eq 'crs') && ($env{'form.form'} eq 'requestcrs'));
         next if ($option eq 'crs' && !$env{'request.course.id'});          next if ($option eq 'crs' && !$env{'request.course.id'});
         if ($curr_selected{'srchin'} eq $option) {          if ($curr_selected{'srchin'} eq $option) {
             $srchinsel .= '               $srchinsel .= ' 
Line 5664  sub user_picker { Line 7018  sub user_picker {
     $srchinsel .= "\n  </select>\n";      $srchinsel .= "\n  </select>\n";
   
     my $srchbysel =  ' <select name="srchby">';      my $srchbysel =  ' <select name="srchby">';
     foreach my $option ('uname','lastname','lastfirst') {      foreach my $option ('lastname','lastfirst','uname') {
         if ($curr_selected{'srchby'} eq $option) {          if ($curr_selected{'srchby'} eq $option) {
             $srchbysel .= '              $srchbysel .= '
    <option value="'.$option.'" selected="selected">'.$lt{$option}.'</option>';     <option value="'.$option.'" selected="selected">'.$lt{$option}.'</option>';
Line 5676  sub user_picker { Line 7030  sub user_picker {
     $srchbysel .= "\n  </select>\n";      $srchbysel .= "\n  </select>\n";
   
     my $srchtypesel = ' <select name="srchtype">';      my $srchtypesel = ' <select name="srchtype">';
     foreach my $option ('exact','begins','contains') {      foreach my $option ('begins','contains','exact') {
         if ($curr_selected{'srchtype'} eq $option) {          if ($curr_selected{'srchtype'} eq $option) {
             $srchtypesel .= '              $srchtypesel .= '
    <option value="'.$option.'" selected="selected">'.$lt{$option}.'</option>';     <option value="'.$option.'" selected="selected">'.$lt{$option}.'</option>';
Line 5690  sub user_picker { Line 7044  sub user_picker {
     my ($newuserscript,$new_user_create);      my ($newuserscript,$new_user_create);
   
     if ($forcenewuser) {      if ($forcenewuser) {
  $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>';          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";          $newuserscript = <<"ENDSCRIPT";
   
 function setSearch(createnew,callingForm) {  function setSearch(createnew,callingForm) {
Line 5723  ENDSCRIPT Line 7093  ENDSCRIPT
   
     my $output = <<"END_BLOCK";      my $output = <<"END_BLOCK";
 <script type="text/javascript">  <script type="text/javascript">
   // <![CDATA[
 function validateEntry(callingForm) {  function validateEntry(callingForm) {
   
     var checkok = 1;      var checkok = 1;
Line 5791  function validateEntry(callingForm) { Line 7162  function validateEntry(callingForm) {
   
 $newuserscript  $newuserscript
   
   // ]]>
 </script>  </script>
   
 $new_user_create  $new_user_create
   
 <table>  
  <tr>  
   <td>$srchbysel  
       $srchtypesel   
       <input type="text" size="15" name="srchterm" value="$srchterm" />  
       $srchinsel   
   </td>  
  </tr>  
  <tr>  
   <td>$lt{'doma'}: $domform</td>  
   </td>  
  </tr>  
 </table>  
 <br />  
 END_BLOCK  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;      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;
   }
   
   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;
   }
   
 =pod  =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  =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
   
 =head1 HTTP Helpers  =head1 HTTP Helpers
   
 =over 4  =over 4
   
 =item * get_unprocessed_cgi($query,$possible_names)  =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 5853  sub get_unprocessed_cgi { Line 7489  sub get_unprocessed_cgi {
   
 =pod  =pod
   
 =item * cacheheader()   =item * &cacheheader() 
   
 returns cache-controlling header code  returns cache-controlling header code
   
Line 5870  sub cacheheader { Line 7506  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 5906  sub content_type { Line 7542  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 5933  sub add_to_env { Line 7569  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 5956  sub get_env_multiple { Line 7592  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 .= '<font size="+2">'.
                                      &mt('View embedded file: [_1]','<a href="'.$url.'">'.
                                      $orig_uploaded_filename.'</a>').'</font><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
   
Line 5965  sub get_env_multiple { Line 7827  sub get_env_multiple {
   
 =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 5995  sub upfile_store { Line 7857  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 6019  sub load_tmp_file { Line 7881  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 6041  sub upfile_record_sep { Line 7903  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 6126  sub record_sep { Line 7988  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 6144  sub upfile_select_html { Line 8006  sub upfile_select_html {
 #                 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 6173  sub get_samples { Line 8035  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 6185  Apache Request ref, $records is an array Line 8047  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 6208  sub csv_print_samples { Line 8072  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 6225  sub csv_print_select_table { Line 8089  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 6252  sub csv_print_select_table { Line 8118  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 6268  sub csv_samples_select_table { Line 8134  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 6282  sub csv_samples_select_table { Line 8151  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 6299  sub csv_samples_select_table { Line 8169  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 6318  sub clean_excel_name { Line 8188  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 6359  sub check_if_partid_hidden { Line 8229  sub check_if_partid_hidden {
   
 =over 4  =over 4
   
 =item get_cgi_id  =item * &get_cgi_id()
   
 Inputs: none  Inputs: none
   
Line 6383  sub get_cgi_id { Line 8253  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 6518  sub DrawBarGraph { Line 8388  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 6527  sub DrawBarGraph { Line 8397  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 6608  sub DrawXYGraph { Line 8478  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 6617  sub DrawXYGraph { Line 8487  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 6710  sub DrawXYYGraph { Line 8580  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 6727  Bad place for them but what the hell. Line 8597  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 6766  sub chartlink { Line 8636  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 6788  a hash ref describing the data to be sto Line 8658  a hash ref describing the data to be sto
   
 Returns: both routines return nothing  Returns: both routines return nothing
   
   =back
   
 =cut  =cut
   
 #######################################################  #######################################################
Line 6840  sub store_settings { Line 8712  sub store_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;
 }  }
   
Line 6868  sub restore_settings { Line 8740  sub restore_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;
   }
   
   ############################################################
   ############################################################
   
   =pod
   
   =head1 Course Catalog Routines
   
   =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)');
                   } 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. 
   
   Returns: $output (markup to be displayed) 
   
   =cut
   
   sub assign_categories_table {
       my ($cathash,$currcat) = @_;
       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') {
                   $output = &Apache::loncommon::start_data_table();
                   my @currcategories;
                   if ($currcat ne '') {
                       @currcategories = split('&',$currcat);
                   }
                   for (my $i=0; $i<@{$cats[0]}; $i++) {
                       my $parent = $cats[0][$i];
                       my $css_class = $itemcount%2?' class="LC_odd_row"':'';
                       next if ($parent eq 'instcode');
                       my $item = &escape($parent).'::0';
                       my $checked = '';
                       if (@currcategories > 0) {
                           if (grep(/^\Q$item\E$/,@currcategories)) {
                               $checked = ' checked="checked" ';
                           }
                       }
                       $output .= '<tr '.$css_class.'><td><span class="LC_nobreak">'.
                                  '<input type="checkbox" name="usecategory" value="'.
                                  $item.'"'.$checked.' />'.$parent.'</span>'.
                                  '<input type="hidden" name="catname" value="'.$parent.'" /></td>';
                       my $depth = 1;
                       push(@path,$parent);
                       $output .= &assign_category_rows($itemcount,\@cats,$depth,$parent,\@path,\@currcategories);
                       pop(@path);
                       $output .= '</tr><tr><td colspan="'.$maxdepth.'" class="LC_row_separator"></td></tr>';
                       $itemcount ++;
                   }
                   $output .= &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 {  sub commit_customrole {
     my ($udom,$uname,$url,$three,$four,$five,$start,$end) = @_;      my ($udom,$uname,$url,$three,$four,$five,$start,$end,$context) = @_;
     my $output = &mt('Assigning custom role').' "'.$five.'" by '.$four.'@'.$three.' in '.$url.      my $output = &mt('Assigning custom role').' "'.$five.'" by '.$four.':'.$three.' in '.$url.
                          ($start?', '.&mt('starting').' '.localtime($start):'').                           ($start?', '.&mt('starting').' '.localtime($start):'').
                          ($end?', ending '.localtime($end):'').': <b>'.                           ($end?', ending '.localtime($end):'').': <b>'.
               &Apache::lonnet::assigncustomrole(                &Apache::lonnet::assigncustomrole(
                  $udom,$uname,$url,$three,$four,$five,$end,$start).                   $udom,$uname,$url,$three,$four,$five,$end,$start,undef,undef,$context).
                  '</b><br />';                   '</b><br />';
     return $output;      return $output;
 }  }
Line 6894  sub commit_standardrole { Line 9180  sub commit_standardrole {
         my $result = &commit_studentrole(\$logmsg,$udom,$uname,$url,$three,$start,$end,          my $result = &commit_studentrole(\$logmsg,$udom,$uname,$url,$three,$start,$end,
                                          $one,$two,$sec,$context);                                           $one,$two,$sec,$context);
         if (($result =~ /^error/) || ($result eq 'not_in_class') ||           if (($result =~ /^error/) || ($result eq 'not_in_class') || 
             ($result eq 'unknown_course')) {              ($result eq 'unknown_course') || ($result eq 'refused')) {
             $output = "Error: $result\n";               $output = $logmsg.' '.&mt('Error: ').$result."\n"; 
         } else {          } else {
             $output = $logmsg.$linefeed.&mt('Assigning').' '.$three.' in '.$url.              $output = $logmsg.$linefeed.&mt('Assigning').' '.$three.' in '.$url.
                ($start?', '.&mt('starting').' '.localtime($start):'').                 ($start?', '.&mt('starting').' '.localtime($start):'').
Line 6912  sub commit_standardrole { Line 9198  sub commit_standardrole {
         $output = &mt('Assigning').' '.$three.' in '.$url.          $output = &mt('Assigning').' '.$three.' in '.$url.
                ($start?', '.&mt('starting').' '.localtime($start):'').                 ($start?', '.&mt('starting').' '.localtime($start):'').
                ($end?', '.&mt('ending').' '.localtime($end):'').': ';                 ($end?', '.&mt('ending').' '.localtime($end):'').': ';
         my $result = &Apache::lonnet::assignrole($udom,$uname,$url,$three,$end,$start);          my $result = &Apache::lonnet::assignrole($udom,$uname,$url,$three,$end,$start,'','',$context);
         if ($context eq 'auto') {          if ($context eq 'auto') {
             $output .= $result.$linefeed;              $output .= $result.$linefeed;
         } else {          } else {
Line 6924  sub commit_standardrole { Line 9210  sub commit_standardrole {
   
 sub commit_studentrole {  sub commit_studentrole {
     my ($logmsg,$udom,$uname,$url,$three,$start,$end,$one,$two,$sec,$context) = @_;      my ($logmsg,$udom,$uname,$url,$three,$start,$end,$one,$two,$sec,$context) = @_;
     my ($result,$linefeed);      my ($result,$linefeed,$oldsecurl,$newsecurl);
     if ($context eq 'auto') {      if ($context eq 'auto') {
         $linefeed = "\n";          $linefeed = "\n";
     } else {      } else {
Line 6936  sub commit_studentrole { Line 9222  sub commit_studentrole {
         my $secchange = 0;          my $secchange = 0;
         my $expire_role_result;          my $expire_role_result;
         my $modify_section_result;          my $modify_section_result;
         unless ($oldsec eq '-1') {          if ($oldsec ne '-1') { 
             unless ($sec eq $oldsec) {              if ($oldsec ne $sec) {
                 $secchange = 1;                  $secchange = 1;
                   my $now = time;
                 my $uurl='/'.$cid;                  my $uurl='/'.$cid;
                 $uurl=~s/\_/\//g;                  $uurl=~s/\_/\//g;
                 if ($oldsec) {                  if ($oldsec) {
                     $uurl.='/'.$oldsec;                      $uurl.='/'.$oldsec;
                 }                  }
                 $expire_role_result = &Apache::lonnet::assignrole($udom,$uname,$uurl,'st',time);                  $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;                  $result = $expire_role_result;
             }              }
         }          }
         if (($expire_role_result eq 'ok') || ($secchange == 0)) {          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);              $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 ($modify_section_result =~ /^ok/) {
                 if ($secchange == 1) {                  if ($secchange == 1) {
                     $$logmsg .= "Section for $uname switched from old section: $oldsec to new section: $sec".$linefeed;                      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') {                  } elsif ($oldsec eq '-1') {
                     $$logmsg .= "New student role for $uname in section $sec in course $cid".$linefeed;                      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 {                  } else {
                     $$logmsg .= "Student $uname assigned to unchanged section $sec in course $cid".$linefeed;                      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 {              } else {
                 $$logmsg .= "Error when attempting section change for $uname from old section $oldsec to new section: $sec in course $cid -error: $modify_section_result".$linefeed;                  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;              $result = $modify_section_result;
         } elsif ($secchange == 1) {          } elsif ($secchange == 1) {
             $$logmsg .= "Error when attempting to expire role for $uname in old section $oldsec in course $cid -error: $expire_role_result".$linefeed;              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 {      } else {
         $$logmsg .= "Incomplete course id defined.  Addition of user $uname from domain $udom to course $one\_$two, section $sec not completed.$linefeed";          $$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";          $result = "error: incomplete course id\n";
     }      }
     return $result;      return $result;
Line 6976  sub commit_studentrole { Line 9317  sub commit_studentrole {
 ############################################################  ############################################################
   
 sub check_clone {  sub check_clone {
     my ($args) = @_;      my ($args,$linefeed) = @_;
     my $cloneid='/'.$args->{'clonedomain'}.'/'.$args->{'clonecourse'};      my $cloneid='/'.$args->{'clonedomain'}.'/'.$args->{'clonecourse'};
     my ($clonecrsudom,$clonecrsunum)= &LONCAPA::split_courseid($cloneid);      my ($clonecrsudom,$clonecrsunum)= &LONCAPA::split_courseid($cloneid);
     my $clonehome=&Apache::lonnet::homeserver($clonecrsunum,$clonecrsudom);      my $clonehome=&Apache::lonnet::homeserver($clonecrsunum,$clonecrsudom);
Line 6984  sub check_clone { Line 9325  sub check_clone {
     my $can_clone = 0;      my $can_clone = 0;
   
     if ($clonehome eq 'no_host') {      if ($clonehome eq 'no_host') {
  $clonemsg = &mt('Attempting to clone non-existing [_1]',          $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'});     
  $args->{'crstype'});  
     } else {      } else {
  my %clonedesc = &Apache::lonnet::coursedescription($cloneid,{'one_time' => 1});   my %clonedesc = &Apache::lonnet::coursedescription($cloneid,{'one_time' => 1});
  if ($env{'request.role.domain'} eq $args->{'clonedomain'}) {          if (($env{'request.role.domain'} eq $args->{'clonedomain'}) && 
     $can_clone = 1;              (&Apache::lonnet::allowed('ccc',$env{'request.role.domain'}))) {
        $can_clone = 1;
  } else {   } else {
     my %clonehash = &Apache::lonnet::get('environment',['cloners'],      my %clonehash = &Apache::lonnet::get('environment',['cloners'],
  $args->{'clonedomain'},$args->{'clonecourse'});   $args->{'clonedomain'},$args->{'clonecourse'});
     my @cloners = split(/,/,$clonehash{'cloners'});      my @cloners = split(/,/,$clonehash{'cloners'});
     my %roleshash =              if (grep(/^\*$/,@cloners)) {
  &Apache::lonnet::get_my_roles($args->{'ccuname'},                  $can_clone = 1;
       $args->{'ccdomain'},'userroles',['active'],['cc'],              } elsif (grep(/^\*\:\Q$args->{'ccdomain'}\E$/,@cloners)) {
       [$args->{'clonedomain'}]);                  $can_clone = 1;
     if (($roleshash{$args->{'clonecourse'}.':'.$args->{'clonedomain'}.':cc'}) || (grep(/^\Q$args->{'ccuname'}\E:\Q$args->{'ccdomain'}\E$/,@cloners))) {              } else {
  $can_clone = 1;          my %roleshash =
     } else {      &Apache::lonnet::get_my_roles($args->{'ccuname'},
  $clonemsg = &mt('The new course was not cloned from an existing course because the new course owner ([_1]) does not have cloning rights in the existing course ([_2]).',$args->{'ccuname'}.':'.$args->{'ccdomain'},$clonedesc{'description'});   $args->{'ccdomain'},
                                            'userroles',['active'],['cc'],
    [$args->{'clonedomain'}]);
           if (($roleshash{$args->{'clonecourse'}.':'.$args->{'clonedomain'}.':cc'}) || (grep(/^\Q$args->{'ccuname'}\E:\Q$args->{'ccdomain'}\E$/,@cloners))) {
       $can_clone = 1;
           } 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);      return ($can_clone, $clonemsg, $cloneid, $clonehome);
 }  }
   
 sub construct_course {  sub construct_course {
     my ($args,$logmsg,$courseid,$crsudom,$crsunum,$udom,$uname,$context) = @_;      my ($args,$logmsg,$courseid,$crsudom,$crsunum,$udom,$uname,$context,$cnum,$category) = @_;
     my $outcome;      my $outcome;
     my $linefeed =  '<br />'."\n";      my $linefeed =  '<br />'."\n";
     if ($context eq 'auto') {      if ($context eq 'auto') {
Line 7022  sub construct_course { Line 9369  sub construct_course {
 #  #
     my ($can_clone, $clonemsg, $cloneid, $clonehome);      my ($can_clone, $clonemsg, $cloneid, $clonehome);
     if (($args->{'clonecourse'}) && ($args->{'clonedomain'})) {      if (($args->{'clonecourse'}) && ($args->{'clonedomain'})) {
  ($can_clone, $clonemsg, $cloneid, $clonehome) = &check_clone($args);   ($can_clone, $clonemsg, $cloneid, $clonehome) = &check_clone($args,$linefeed);
  if ($context ne 'auto') {   if ($context ne 'auto') {
     $clonemsg = '<span class="LC_error">'.$clonemsg.'</span>';              if ($clonemsg ne '') {
           $clonemsg = '<span class="LC_error">'.$clonemsg.'</span>';
               }
  }   }
  $outcome .= $clonemsg.$linefeed;   $outcome .= $clonemsg.$linefeed;
   
Line 7046  sub construct_course { Line 9395  sub construct_course {
                                              $args->{'crscode'},                                               $args->{'crscode'},
                                              $args->{'ccuname'}.':'.                                               $args->{'ccuname'}.':'.
                                              $args->{'ccdomain'},                                               $args->{'ccdomain'},
                                              $args->{'crstype'});                                               $args->{'crstype'},
                                                $cnum,$context,$category);
   
   
     # Note: The testing routines depend on this being output; see       # Note: The testing routines depend on this being output; see 
     # Utils::Course. This needs to at least be output as a comment      # Utils::Course. This needs to at least be output as a comment
Line 7071  sub construct_course { Line 9422  sub construct_course {
  $outcome .= $clonemsg.$linefeed;   $outcome .= $clonemsg.$linefeed;
  my %oldcenv=&Apache::lonnet::dump('environment',$$crsudom,$$crsunum);   my %oldcenv=&Apache::lonnet::dump('environment',$$crsudom,$$crsunum);
 # Copy all files  # Copy all files
  &Apache::lonclonecourse::copycoursefiles($cloneid,$$courseid);   &Apache::lonclonecourse::copycoursefiles($cloneid,$$courseid,$args->{'datemode'},$args->{'dateshift'});
 # Restore URL  # Restore URL
  $cenv{'url'}=$oldcenv{'url'};   $cenv{'url'}=$oldcenv{'url'};
 # Restore title  # Restore title
  $cenv{'description'}=$oldcenv{'description'};   $cenv{'description'}=$oldcenv{'description'};
 # restore grading mode  
  if (defined($oldcenv{'grading'})) {  
     $cenv{'grading'}=$oldcenv{'grading'};  
  }  
 # Mark as cloned  # Mark as cloned
  $cenv{'clonedfrom'}=$cloneid;   $cenv{'clonedfrom'}=$cloneid;
  delete($cenv{'default_enrollment_start_date'});  # Need to clone grading mode
  delete($cenv{'default_enrollment_end_date'});          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);
     }      }
   
 #  #
Line 7111  sub construct_course { Line 9471  sub construct_course {
     } else {      } else {
         $cenv{'internal.courseowner'} = $args->{'curruser'};          $cenv{'internal.courseowner'} = $args->{'curruser'};
     }      }
   
     my @badclasses = (); # Used to accumulate sections/crosslistings that did not pass classlist access check for course owner.      my @badclasses = (); # Used to accumulate sections/crosslistings that did not pass classlist access check for course owner.
     if ($args->{'crssections'}) {      if ($args->{'crssections'}) {
         $cenv{'internal.sectionnums'} = '';          $cenv{'internal.sectionnums'} = '';
Line 7171  sub construct_course { Line 9530  sub construct_course {
     }      }
     if ($args->{'notify_dc'}) {      if ($args->{'notify_dc'}) {
         if ($uname ne '') {           if ($uname ne '') { 
             push(@notified,$uname.'@'.$udom);              push(@notified,$uname.':'.$udom);
         }          }
     }      }
     if (@notified > 0) {      if (@notified > 0) {
Line 7311  sub construct_course { Line 9670  sub construct_course {
         $outcome .= ($fatal?$errtext:'read ok').' - ';          $outcome .= ($fatal?$errtext:'read ok').' - ';
         my $title; my $url;          my $title; my $url;
         if ($args->{'firstres'} eq 'syl') {          if ($args->{'firstres'} eq 'syl') {
     $title='Syllabus';      $title=&mt('Syllabus');
             $url='/public/'.$$crsudom.'/'.$$crsunum.'/syllabus';              $url='/public/'.$$crsudom.'/'.$$crsunum.'/syllabus';
         } else {          } else {
             $title='Navigate Contents';              $title=&mt('Navigate Contents');
             $url='/adm/navmaps';              $url='/adm/navmaps';
         }          }
   
Line 7346  sub course_type { Line 9705  sub course_type {
 sub group_term {  sub group_term {
     my $crstype = &course_type();      my $crstype = &course_type();
     my %names = (      my %names = (
                   'Course' => 'group',                    'Course'    => 'group',
                   'Group' => 'team',                    'Community' => 'group',
                 );                  );
     return $names{$crstype};      return $names{$crstype};
 }  }
Line 7369  sub icon { Line 9728  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 7408  sub escape_url { Line 9770  sub escape_url {
     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;
   }
   
 # -------------------------------------------------------- Initliaze user login  # -------------------------------------------------------- Initliaze user login
 sub init_user_environment {  sub init_user_environment {
     my ($r, $username, $domain, $authhost, $form, $args) = @_;      my ($r, $username, $domain, $authhost, $form, $args) = @_;
Line 7450  sub init_user_environment { Line 9828  sub init_user_environment {
  }   }
 # Give them a new cookie  # Give them a new cookie
  my $id = ($args->{'robot'} ? 'robot'.$args->{'robot'}   my $id = ($args->{'robot'} ? 'robot'.$args->{'robot'}
                    : $now);                     : $now.$$.int(rand(10000)));
  $cookie="$username\_$id\_$domain\_$authhost";   $cookie="$username\_$id\_$domain\_$authhost";
           
 # Initialize roles  # Initialize roles
Line 7538  sub init_user_environment { Line 9916  sub init_user_environment {
     }      }
  }   }
   
           foreach my $tool ('aboutme','blog','portfolio') {
               $userenv{'availabletools.'.$tool} =
                   &Apache::lonnet::usertools_access($username,$domain,$tool,'reload');
           }
   
           foreach my $crstype ('official','unofficial','community') {
               $userenv{'canrequest.'.$crstype} =
                   &Apache::lonnet::usertools_access($username,$domain,$crstype,
                                                     'reload','requestcourses');
           }
   
  $env{'user.environment'} = "$lonids/$cookie.id";   $env{'user.environment'} = "$lonids/$cookie.id";
   
  if (tie(my %disk_env,'GDBM_File',"$lonids/$cookie.id",   if (tie(my %disk_env,'GDBM_File',"$lonids/$cookie.id",
Line 7565  sub init_user_environment { Line 9954  sub init_user_environment {
   
 sub _add_to_env {  sub _add_to_env {
     my ($idf,$env_data,$prefix) = @_;      my ($idf,$env_data,$prefix) = @_;
     while (my ($key,$value) = each(%$env_data)) {      if (ref($env_data) eq 'HASH') {
  $idf->{$prefix.$key} = $value;          while (my ($key,$value) = each(%$env_data)) {
  $env{$prefix.$key}   = $value;      $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
   

Removed from v.1.572  
changed lines
  Added in v.1.692.4.19


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