Diff for /loncom/interface/loncommon.pm between versions 1.587 and 1.692.2.4

version 1.587, 2007/09/24 23:29:53 version 1.692.2.4, 2008/12/14 04:22:39
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 367  sub selectstudent_link { Line 441  sub selectstudent_link {
    return '';     return '';
        }         }
        return "<a href='".'javascript:openstdbrowser("'.$form.'","'.$unameele.         return "<a href='".'javascript:openstdbrowser("'.$form.'","'.$unameele.
         '","'.$udomele.'","","1");'."'>".&mt('Select User')."</a>";          '","'.$udomele.'");'."'>".&mt('Select User')."</a>";
    }     }
    if ($env{'request.role'}=~/^(au|dc|su)/) {     if ($env{'request.role'}=~/^(au|dc|su)/) {
        return "<a href='".'javascript:openstdbrowser("'.$form.'","'.$unameele.         return "<a href='".'javascript:openstdbrowser("'.$form.'","'.$unameele.
Line 376  sub selectstudent_link { Line 450  sub selectstudent_link {
    return '';     return '';
 }  }
   
   sub authorbrowser_javascript {
       return <<"ENDAUTHORBRW";
   <script type="text/javascript">
   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 Group - for which you wish to add/modify a user role');
Line 407  sub coursebrowser_javascript { Line 500  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 471  sub setsec_javascript { Line 564  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 510  sub selectcourse_link { Line 606  sub selectcourse_link {
         '","'.$udomele.'","'.$desc.'","'.$extra_element.'","'.$multflag.'","'.$selecttype.'");'."'>".&mt('Select Course')."</a>";          '","'.$udomele.'","'.$desc.'","'.$extra_element.'","'.$multflag.'","'.$selecttype.'");'."'>".&mt('Select Course')."</a>";
 }  }
   
   sub selectauthor_link {
      my ($form,$udom)=@_;
      return '<a href="javascript:openauthorbrowser('."'$form','$udom'".');">'.
             &mt('Select Author').'</a>';
   }
   
 sub check_uncheck_jscript {  sub check_uncheck_jscript {
     my $jscript = <<"ENDSCRT";      my $jscript = <<"ENDSCRT";
 function checkAll(field) {  function checkAll(field) {
Line 535  ENDSCRT Line 637  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;
   }
   
 =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 736  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 754  $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 763  $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 776  $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 789  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";
Line 624  sub linked_select_forms { Line 804  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 663  function select1_changed() { Line 846  function select1_changed() {
 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 860  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 877  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 926  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 .= <<"ENDTEMPLATE";
  <a target="_top" href="$link" title="$title"><img src="$helpicon" border="0" alt="(Help: $topic)" /></a>   <a target="_top" href="$link" title="$title"><img src="$helpicon" border="0" alt="(Help: $topic)" /></a>
 ENDTEMPLATE  ENDTEMPLATE
     if ($text ne '') { $template.='</td></tr></table>' };      if ($text ne '') { $template.='</span></td></tr></table>' };
     return $template;      return $template;
   
 }  }
Line 760  sub helpLatexCheatsheet { Line 952  sub helpLatexCheatsheet {
     }      }
     return '<table><tr><td>'.      return '<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><td>'.
    &Apache::loncommon::help_open_topic("Authoring_Output_Tags",&mt('Output Tags'),
                                       undef,undef,600)
  .'</td></tr></table>';   .'</td></tr></table>';
 }  }
   
Line 774  sub general_help { Line 969  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 995  ENDTEMPLATE Line 1192  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 1247  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 1271  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 1351  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 = {};  $geometry
 function init_geometry() {  
     if (Geometry.init) { return };  function getX(element) {
     Geometry.init=1;      var x = 0;
     if (window.innerHeight) {      while (element) {
  Geometry.getViewportHeight = function() { return window.innerHeight; };   x += element.offsetLeft;
     }   element = element.offsetParent;
     else if (document.documentElement && document.documentElement.clientHeight) {      }
  Geometry.getViewportHeight =       return x;
     function() { return document.documentElement.clientHeight; };  }
     }  function getY(element) {
     else if (document.body.clientHeight) {      var y = 0;
  Geometry.getViewportHeight =       while (element) {
     function() { return document.body.clientHeight; };   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;
Line 1131  RESIZE Line 1404  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 1415  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 1436  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 1492  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 1535  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 1560  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 1603  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 1384  sub multiple_select_form { Line 1653  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 1471  sub select_level_form { Line 1740  sub select_level_form {
   
 =pod  =pod
   
 =item * select_dom_form($defdom,$name,$includeempty,$showdomdesc)  =item * &select_dom_form($defdom,$name,$includeempty,$showdomdesc)
   
 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 1511  sub select_dom_form { Line 1780  sub select_dom_form {
   
 =pod  =pod
   
 =item * home_server_form_item($domain,$name,$defaultflag)  =item * &home_server_form_item($domain,$name,$defaultflag)
   
 input: 4 arguments (two required, two optional) -   input: 4 arguments (two required, two optional) - 
     $domain - domain of new user      $domain - domain of new user
Line 1520  input: 4 arguments (two required, two op Line 1789  input: 4 arguments (two required, two op
                             option, and selected by default.                               option, and selected by default. 
     $hide - Value of 'hide' causes hiding of the name of the server,       $hide - Value of 'hide' causes hiding of the name of the server, 
                             if 1 server found, or default, if 0 found.                              if 1 server found, or default, if 0 found.
 output: returns 1 items:   output: returns 2 items: 
 (a) form element which contains either:  (a) form element which contains either:
    (i) <select name="$name">     (i) <select name="$name">
         <option value="$hostid1">$hostid $servers{$hostid}</option>          <option value="$hostid1">$hostid $servers{$hostid}</option>
Line 1671  sub decode_user_agent { Line 1940  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 1695  See loncreateuser.pm for invocation and Line 1962  See loncreateuser.pm for invocation and
   
 =back  =back
   
 =back   See loncreateuser.pm for invocation and use examples.
   
 =cut  =cut
   
Line 1725  END Line 1992  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 1834  sub authform_nochange{ Line 2098  sub authform_nochange{
     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',
Line 1850  sub authform_kerberos{ Line 2114  sub authform_kerberos{
        $check4 = ' checked="on"';         $check4 = ' checked="on"';
     }      }
     $krbarg = $in{'kerb_def_dom'};      $krbarg = $in{'kerb_def_dom'};
     if (grep(/^curr_authtype$/,(keys(%in)))) {      if (defined($in{'curr_authtype'})) {
         if ($in{'curr_authtype'} =~ m/^krb(\d+)$/) {          if ($in{'curr_authtype'} eq 'krb') {
             $krbver = $1;  
             $krbcheck = ' checked="on"';              $krbcheck = ' checked="on"';
             if ($krbver eq '5') {              if (defined($in{'mode'})) {
                 $check5 = ' checked="on"';                  if ($in{'mode'} eq 'modifyuser') {
                 $check4 = '';                      $krbcheck = '';
             } else {                  }
                 $check4 = ' checked="on"';              }
                 $check5 = '';              if (defined($in{'curr_kerb_ver'})) {
                   if ($in{'curr_krb_ver'} eq '5') {
                       $check5 = ' checked="on"';
                       $check4 = '';
                   } else {
                       $check4 = ' checked="on"';
                       $check5 = '';
                   }
             }              }
             if (grep(/^curr_autharg$/,(keys(%in)))) {              if (defined($in{'curr_autharg'})) {
                 $krbarg = $in{'curr_autharg'};                  $krbarg = $in{'curr_autharg'};
             }              }
             if (!$can_assign{'krb4'} && !$can_assign{'krb5'}) {              if (!$can_assign{'krb4'} && !$can_assign{'krb5'}) {
                 if (grep(/^curr_autharg$/,(keys(%in)))) {                  if (defined($in{'curr_autharg'})) {
                     $result =                       $result = 
     &mt('Currently Kerberos authenticated with domain [_1] Version [_2].',      &mt('Currently Kerberos authenticated with domain [_1] Version [_2].',
         $in{'curr_autharg'},$krbver);          $in{'curr_autharg'},$krbver);
Line 1884  sub authform_kerberos{ Line 2154  sub authform_kerberos{
     if (!$can_assign{'krb4'} && !$can_assign{'krb5'}) {      if (!$can_assign{'krb4'} && !$can_assign{'krb5'}) {
         return;          return;
     } elsif ($authtype eq '') {      } elsif ($authtype eq '') {
         if (grep(/^mode$/,(keys(%in)))) {          if (defined($in{'mode'})) {
             if ($in{'mode'} eq 'modifycourse') {              if ($in{'mode'} eq 'modifycourse') {
                 if ($authnum == 1) {                  if ($authnum == 1) {
                     $authtype = '<input type="hidden" name="login" value="krb">';                      $authtype = '<input type="hidden" name="login" value="krb">';
Line 1945  sub authform_internal{ Line 2215  sub authform_internal{
                 );                  );
     my ($intcheck,$intarg,$result,$authtype,$autharg,$jscall);      my ($intcheck,$intarg,$result,$authtype,$autharg,$jscall);
     my ($authnum,%can_assign) =  &get_assignable_auth($in{'domain'});      my ($authnum,%can_assign) =  &get_assignable_auth($in{'domain'});
     if (grep(/^curr_authtype$/,(keys(%in)))) {      if (defined($in{'curr_authtype'})) {
         if ($in{'curr_authtype'} eq 'internal:') {          if ($in{'curr_authtype'} eq 'int') {
             if ($can_assign{'int'}) {              if ($can_assign{'int'}) {
                 $intcheck = 'checked="on" ';                  $intcheck = 'checked="on" ';
                 if (grep(/^curr_autharg$/,(keys(%in)))) {                  if (defined($in{'mode'})) {
                       if ($in{'mode'} eq 'modifyuser') {
                           $intcheck = '';
                       }
                   }
                   if (defined($in{'curr_autharg'})) {
                     $intarg = $in{'curr_autharg'};                      $intarg = $in{'curr_autharg'};
                 }                  }
             } else {              } else {
Line 1965  sub authform_internal{ Line 2240  sub authform_internal{
     if (!$can_assign{'int'}) {      if (!$can_assign{'int'}) {
         return;          return;
     } elsif ($authtype eq '') {      } elsif ($authtype eq '') {
         if (grep(/^mode$/,(keys(%in)))) {          if (defined($in{'mode'})) {
             if ($in{'mode'} eq 'modifycourse') {              if ($in{'mode'} eq 'modifycourse') {
                 if ($authnum == 1) {                  if ($authnum == 1) {
                     $authtype = '<input type="hidden" name="login" value="int">';                      $authtype = '<input type="hidden" name="login" value="int">';
Line 1978  sub authform_internal{ Line 2253  sub authform_internal{
         $authtype = '<input type="radio" name="login" value="int" '.$intcheck.          $authtype = '<input type="radio" name="login" value="int" '.$intcheck.
                     ' onchange="'.$jscall.'" onclick="'.$jscall.'" />';                      ' onchange="'.$jscall.'" onclick="'.$jscall.'" />';
     }      }
     $autharg = '<input type="text" size="10" name="intarg" value="'.      $autharg = '<input type="password" size="10" name="intarg" value="'.
                $intarg.'" onchange="'.$jscall.'" />';                 $intarg.'" onchange="'.$jscall.'" />';
     $result = &mt      $result = &mt
         ('[_1] Internally authenticated (with initial password [_2])',          ('[_1] Internally authenticated (with initial password [_2])',
          '<label>'.$authtype,'</label>'.$autharg);           '<label>'.$authtype,'</label>'.$autharg);
       $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>';
     return $result;      return $result;
 }  }
   
Line 1994  sub authform_local{ Line 2270  sub authform_local{
               );                );
     my ($loccheck,$locarg,$result,$authtype,$autharg,$jscall);      my ($loccheck,$locarg,$result,$authtype,$autharg,$jscall);
     my ($authnum,%can_assign) =  &get_assignable_auth($in{'domain'});      my ($authnum,%can_assign) =  &get_assignable_auth($in{'domain'});
     if (grep(/^curr_authtype$/,(keys(%in)))) {      if (defined($in{'curr_authtype'})) {
         if ($in{'curr_authtype'} eq 'localauth:') {          if ($in{'curr_authtype'} eq 'loc') {
             if ($can_assign{'loc'}) {              if ($can_assign{'loc'}) {
                 $loccheck = 'checked="on" ';                  $loccheck = 'checked="on" ';
                 if (grep(/^curr_autharg$/,(keys(%in)))) {                  if (defined($in{'mode'})) {
                       if ($in{'mode'} eq 'modifyuser') {
                           $loccheck = '';
                       }
                   }
                   if (defined($in{'curr_autharg'})) {
                     $locarg = $in{'curr_autharg'};                      $locarg = $in{'curr_autharg'};
                 }                  }
             } else {              } else {
Line 2014  sub authform_local{ Line 2295  sub authform_local{
     if (!$can_assign{'loc'}) {      if (!$can_assign{'loc'}) {
         return;          return;
     } elsif ($authtype eq '') {      } elsif ($authtype eq '') {
         if (grep(/^mode$/,(keys(%in)))) {          if (defined($in{'mode'})) {
             if ($in{'mode'} eq 'modifycourse') {              if ($in{'mode'} eq 'modifycourse') {
                 if ($authnum == 1) {                  if ($authnum == 1) {
                     $authtype = '<input type="hidden" name="login" value="loc">';                      $authtype = '<input type="hidden" name="login" value="loc">';
Line 2043  sub authform_filesystem{ Line 2324  sub authform_filesystem{
               );                );
     my ($fsyscheck,$result,$authtype,$autharg,$jscall);      my ($fsyscheck,$result,$authtype,$autharg,$jscall);
     my ($authnum,%can_assign) =  &get_assignable_auth($in{'domain'});      my ($authnum,%can_assign) =  &get_assignable_auth($in{'domain'});
     if (grep(/^curr_authtype$/,(keys(%in)))) {      if (defined($in{'curr_authtype'})) {
         if ($in{'curr_authtype'} eq 'unix:') {          if ($in{'curr_authtype'} eq 'fsys') {
             if ($can_assign{'fsys'}) {              if ($can_assign{'fsys'}) {
                 $fsyscheck = 'checked="on" ';                  $fsyscheck = 'checked="on" ';
                   if (defined($in{'mode'})) {
                       if ($in{'mode'} eq 'modifyuser') {
                           $fsyscheck = '';
                       }
                   }
             } else {              } else {
                 $result = &mt('Currently Filesystem Authenticated.');                  $result = &mt('Currently Filesystem Authenticated.');
                 return $result;                  return $result;
Line 2060  sub authform_filesystem{ Line 2346  sub authform_filesystem{
     if (!$can_assign{'fsys'}) {      if (!$can_assign{'fsys'}) {
         return;          return;
     } elsif ($authtype eq '') {      } elsif ($authtype eq '') {
         if (grep(/^mode$/,(keys(%in)))) {          if (defined($in{'mode'})) {
             if ($in{'mode'} eq 'modifycourse') {              if ($in{'mode'} eq 'modifycourse') {
                 if ($authnum == 1) {                  if ($authnum == 1) {
                     $authtype = '<input type="hidden" name="login" value="fsys">';                      $authtype = '<input type="hidden" name="login" value="fsys">';
Line 2080  sub authform_filesystem{ Line 2366  sub authform_filesystem{
         ('[_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" '.
          $fsyscheck.'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;
 }  }
Line 2128  sub get_assignable_auth { Line 2414  sub get_assignable_auth {
 }  }
   
 ###############################################################  ###############################################################
 ##    Get Authentication Defaults for Domain                 ##  
 ###############################################################  
   
 =pod  
   
 =head1 Domains and Authentication  
   
 Returns default authentication type and an associated argument as  
 listed in file 'domain.tab'.  
   
 =over 4  
   
 =item * get_auth_defaults  
   
 get_auth_defaults($target_domain) returns the default authentication  
 type and an associated argument (initial password or a kerberos domain).  
 These values are stored in lonTabs/domain.tab  
   
 ($def_auth, $def_arg) = &get_auth_defaults($target_domain);  
   
 If target_domain is not found in domain.tab, returns nothing ('').  
   
 =cut  
   
 #-------------------------------------------  
 sub get_auth_defaults {  
     my $domain=shift;  
     return (&Apache::lonnet::domain($domain,'auth_def'),  
     &Apache::lonnet::domain($domain,'auth_arg_def'));  
       
 }  
 ###############################################################  
 ##   End Get Authentication Defaults for Domain              ##  
 ###############################################################  
   
 ###############################################################  
 ##    Get Kerberos Defaults for Domain                 ##  ##    Get Kerberos Defaults for Domain                 ##
 ###############################################################  ###############################################################
 ##  ##
Line 2175  sub get_auth_defaults { Line 2425  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 2199  sub get_kerberos_defaults { Line 2458  sub get_kerberos_defaults {
     return ($krbdef,$krbdefdom);      return ($krbdef,$krbdefdom);
 }  }
   
 =pod  
   
 =back  
   
 =cut  
   
 ###############################################################  ###############################################################
 ##                Thesaurus Functions                        ##  ##                Thesaurus Functions                        ##
Line 2215  sub get_kerberos_defaults { Line 2469  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 2260  sub initialize_keywords { Line 2514  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 2281  sub keyword { Line 2535  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 2339  sub get_related_words { Line 2593  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 2368  sub plainname { Line 2622  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 2418  sub getnames { Line 2672  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 2464  sub flush_email_cache { Line 2721  sub flush_email_cache {
   
 =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 2560  sub student_image_tag { Line 2817  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 2572  sub languageids { Line 2829  sub languageids {
   
 =pod  =pod
   
 =item * languagedescription()   =item * &languagedescription() 
   
 returns description of a specified language id  returns description of a specified language id
   
Line 2597  sub supportedlanguagecode { Line 2854  sub supportedlanguagecode {
   
 =pod  =pod
   
 =item * copyrightids()   =item * &copyrightids() 
   
 returns list of all copyrights  returns list of all copyrights
   
Line 2609  sub copyrightids { Line 2866  sub copyrightids {
   
 =pod  =pod
   
 =item * copyrightdescription()   =item * &copyrightdescription() 
   
 returns description of a specified copyright id  returns description of a specified copyright id
   
Line 2621  sub copyrightdescription { Line 2878  sub copyrightdescription {
   
 =pod  =pod
   
 =item * source_copyrightids()   =item * &source_copyrightids() 
   
 returns list of all source copyrights  returns list of all source copyrights
   
Line 2633  sub source_copyrightids { Line 2890  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 2645  sub source_copyrightdescription { Line 2902  sub source_copyrightdescription {
   
 =pod  =pod
   
 =item * filecategories()   =item * &filecategories() 
   
 returns list of all file categories  returns list of all file categories
   
Line 2657  sub filecategories { Line 2914  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 2671  sub filecategorytypes { Line 2928  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 2695  sub filecategoryselect { Line 2952  sub filecategoryselect {
   
 =pod  =pod
   
 =item * filedescription()   =item * &filedescription() 
   
 returns description for a specified file type  returns description for a specified file type
   
Line 2709  sub filedescription { Line 2966  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 2741  sub fileextensions { Line 2998  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 2753  sub display_languages { Line 3010  sub display_languages {
     return %languages;      return %languages;
 }  }
   
 sub preferred_languages {  
     my @languages=();  
     if ($env{'course.'.$env{'request.course.id'}.'.languages'}) {  
  @languages=(@languages,split(/\s*(\,|\;|\:)\s*/,  
          $env{'course.'.$env{'request.course.id'}.'.languages'}));  
     }  
     if ($env{'environment.languages'}) {  
  @languages=(@languages,  
     split(/\s*(\,|\;|\:)\s*/,$env{'environment.languages'}));  
     }  
     my $browser=$ENV{'HTTP_ACCEPT_LANGUAGE'};  
     if ($browser) {  
  my @browser =   
     map { (split(/\s*;\s*/,$_))[0] } (split(/\s*,\s*/,$browser));  
  push(@languages,@browser);  
     }  
     if (&Apache::lonnet::domain($env{'user.domain'},'lang_def')) {  
  @languages=(@languages,  
     &Apache::lonnet::domain($env{'user.domain'},  
     'lang_def'));  
     }  
     if (&Apache::lonnet::domain($env{'request.role.domain'},'lang_def')) {  
  @languages=(@languages,  
     &Apache::lonnet::domain($env{'request.role.domain'},  
     'lang_def'));  
     }  
     if (&Apache::lonnet::domain($Apache::lonnet::perlvar{'lonDefDomain'},  
  'lang_def')) {  
  @languages=(@languages,  
     &Apache::lonnet::domain($Apache::lonnet::perlvar{'lonDefDomain'},  
     'lang_def'));  
     }  
 # turn "en-ca" into "en-ca,en"  
     my @genlanguages;  
     foreach my $lang (@languages) {  
  unless ($lang=~/\w/) { next; }  
  push(@genlanguages,$lang);  
  if ($lang=~/(\-|\_)/) {  
     push(@genlanguages,(split(/(\-|\_)/,$lang))[0]);  
  }  
     }  
     #uniqueify the languages list  
     my %count;  
     @genlanguages = map { $count{$_}++ == 0 ? $_ : () } @genlanguages;  
     return @genlanguages;  
 }  
   
 sub languages {  sub languages {
     my ($possible_langs) = @_;      my ($possible_langs) = @_;
     my @preferred_langs = &preferred_languages();      my @preferred_langs = &Apache::lonlocal::preferred_languages();
     if (!ref($possible_langs)) {      if (!ref($possible_langs)) {
  if( wantarray ) {   if( wantarray ) {
     return @preferred_langs;      return @preferred_langs;
Line 2833  sub languages { Line 3043  sub 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 2877  sub get_previous_attempt { Line 3087  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 2893  sub get_previous_attempt { Line 3103  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 = &format_previous_attempt_value($key,   my $value = &format_previous_attempt_value($key,
    $returnhash{$version.':'.$key});     $returnhash{$version.':'.$key});
  $prevattempts.='<td>'.$value.'&nbsp;</td>';      $prevattempts.='<td>'.$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 = &format_previous_attempt_value($key,$lasthash{$key});   my $value = &format_previous_attempt_value($key,$lasthash{$key});
  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();
   }    }
 }  }
   
Line 2968  sub relative_to_absolute { Line 3187  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 2987  sub get_student_view { Line 3206  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 2996  sub get_student_view { Line 3215  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 3089  sub pprmlink { Line 3340  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 3105  sub pprmlink { Line 3356  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 3124  sub utc_string { Line 3380  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 3504  sub blocking_status { Line 3778  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 3547  sub get_domainconf { Line 3875  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 3635  Returns: value of designparamter $which Line 4003  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 3657  sub designparm { Line 4025  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 3825  ENDROLE Line 4193  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 3848  ENDROLE Line 4216  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 3974  sub make_attr_string { Line 4342  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 4019  sub standard_css { Line 4394  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     = '#EEEEEE';
Line 4037  sub standard_css { Line 4412  sub standard_css {
     my $table_header         = '#DDDDDD';      my $table_header         = '#DDDDDD';
     my $feedback_link_bg     = '#BBBBBB';      my $feedback_link_bg     = '#BBBBBB';
   
     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'     ) ? '0px 2px 0px 2px'
                                                    : '0px 3px 0px 4px';
   
   
     return <<END;      return <<END;
Line 4058  table.thinborder tr td { Line 4434  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 4099  table.LC_pastsubmission { Line 4475  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;
Line 4107  table#LC_top_nav, table#LC_menubuttons { Line 4483  table#LC_top_nav, table#LC_menubuttons {
   padding: 0px;    padding: 0px;
 }  }
   
 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 4209  table.LC_docs_path td.LC_docs_path_compo Line 4585  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 4223  table#LC_mainmenu td.LC_mainmenu_column Line 4598  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 4247  td.LC_menubuttons_img { Line 4622  td.LC_menubuttons_img {
 }  }
 .LC_new_mail {  .LC_new_mail {
   font-family: $sans;    font-family: $sans;
     background: $tabbg;
   font-weight: bold;    font-weight: bold;
 }  }
   
Line 4289  td.LC_menubuttons_img { Line 4665  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: 0px;
   border-collapse: collapse;    border-collapse: collapse;
Line 4298  table.LC_data_table, table.LC_mail_list Line 4682  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: 0px;
   width: 100%;    width: 100%;
 }  }
 table.LC_nested {  table.LC_nested {
   border: 0px;    border: 0px;
   border-collapse: separate;    border-collapse: collapse;
   border-spacing: 0px;    border-spacing: 0px;
   width: 100%;    width: 100%;
 }  }
Line 4320  table.LC_prior_tries tr th { Line 4705  table.LC_prior_tries tr th {
   background-color: $data_table_head;    background-color: $data_table_head;
   font-size: smaller;    font-size: smaller;
 }  }
 table.LC_data_table tr td,   table.LC_data_table tr.LC_info_row > td {
     background-color: #CCC;
     font-weight: bold;
     text-align: left;
   }
   table.LC_data_table tr.LC_odd_row > td, 
 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_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;
 }  }
 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 4362  table.LC_nested tr.LC_info_row td { Line 4756  table.LC_nested tr.LC_info_row td {
   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 {
Line 4606  table.LC_pick_box td.LC_pick_box_title { Line 5001  table.LC_pick_box td.LC_pick_box_title {
   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 {  table.LC_pick_box td.LC_pick_box_value {
   text-align: left;    text-align: left;
   padding: 8px;    padding: 8px;
Line 4731  table.LC_descriptive_input td.LC_descrip Line 5134  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 4812  span.LC_cusr_emph { Line 5223  span.LC_cusr_emph {
   font-style: italic;    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: 0px;
Line 4886  table.LC_sty_end { Line 5302  table.LC_sty_end {
   background: #FFBBBB;    background: #FFBBBB;
 }  }
   
   table.LC_double_column {
     border-width: 0px;
     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: 0px
   }
   
   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: 0px;
   }
   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:0px 10px 10px 0px;
   
   }
 END  END
 }  }
   
Line 4979  Inputs: none Line 5579  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 5002  Inputs: none Line 5599  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 5039  sub endheadtag { Line 5638  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 5055  sub head { Line 5661  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 5179  sub end_page { Line 5795  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 5251  sub simple_error_page { Line 5867  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 5284  sub simple_error_page { Line 5900  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 5556  previous, future, or all. Line 6172  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 5570  of the possibility of multiple values fo Line 6191  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 5590  sub get_course_users { Line 6211  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 5609  sub get_course_users { Line 6231  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 5617  sub get_course_users { Line 6238  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 5669  sub get_course_users { Line 6311  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 5691  sub get_course_users { Line 6339  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 5700  sub get_course_users { Line 6351  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 5728  sub get_user_info { Line 6389  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 5848  sub default_quota { Line 6511  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 = 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 5917  sub get_secgrprole_info { Line 6596  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 => 'lastname',                          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 6011  sub user_picker { Line 6690  sub user_picker {
     if ($forcenewuser) {      if ($forcenewuser) {
         if (ref($srch) eq 'HASH') {          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 ($srch->{'srchby'} eq 'uname' && $srch->{'srchtype'} eq 'exact' && $srch->{'srchin'} eq 'dom' && $srch->{'srchdomain'} eq $env{'request.role.domain'}) {
         $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 ($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 = ' href="javascript:helpMenu('."'display'".')"';
                       my %usertypetext = (
                           official   => 'institutional',
                           unofficial => 'non-institutional',
                       );
                       $new_user_create = '<br /><span class="LC_warning">'.&mt("You are not authorized to create new $usertypetext{$usertype} users in this domain.").' '.&mt('Contact the <a[_1]>helpdesk</a> for assistance.',$helplink).'</span><br /><br />';
                   }
             }              }
         }          }
   
Line 6140  END_BLOCK Line 6828  END_BLOCK
     return $output;      return $output;
 }  }
   
 sub username_rule_check {  sub user_rule_check {
     my ($srch,$caller) = @_;      my ($usershash,$checks,$alerts,$rulematch,$inst_results,$curr_rules,$got_rules) = @_;
     my ($response,@curr_rules,%inst_results,$rulematch);      my $response;
     my ($rules,$ruleorder) = &Apache::lonnet::inst_userrules($srch->{'srchdomain'});      if (ref($usershash) eq 'HASH') {
     if (ref($srch) eq 'HASH') {          foreach my $user (keys(%{$usershash})) {
         (my $inst_response,%inst_results) =               my ($uname,$udom) = split(/:/,$user);
             &Apache::lonnet::get_instuser($srch->{'srchdomain'},              next if ($udom eq '' || $uname eq '');
                                           $srch->{'srchterm'});              my ($id,$newuser);
         my %domconfig = &Apache::lonnet::get_dom('configuration',              if (ref($usershash->{$user}) eq 'HASH') {
                               ['usercreation'],$srch->{'srchdomain'});                  $newuser = $usershash->{$user}->{'newuser'};
         if (ref($domconfig{'usercreation'}) eq 'HASH') {                  $id = $usershash->{$user}->{'id'};
             if (ref($domconfig{'usercreation'}{'username_rule'}) eq 'ARRAY') {              }
                 @curr_rules = @{$domconfig{'usercreation'}{'username_rule'}};              my $inst_response;
             }              if (ref($checks) eq 'HASH') {
         }                  if (defined($checks->{'username'})) {
         if (@curr_rules > 0) {                      ($inst_response,%{$inst_results->{$user}}) = 
             my $domdesc = &Apache::lonnet::domain($srch->{'srchdomain'},'description');                          &Apache::lonnet::get_instuser($udom,$uname);
             my $instuser_reqd;                  } elsif (defined($checks->{'id'})) {
             my %rule_check = &Apache::lonnet::inst_rulecheck($srch->{'srchdomain'},$srch->{'srchterm'},\@curr_rules);                      ($inst_response,%{$inst_results->{$user}}) =
             foreach my $rule (@curr_rules) {                          &Apache::lonnet::get_instuser($udom,undef,$id);
                 if ($rule_check{$rule}) {                  }
                     $rulematch = $rule;              } else {
                     if ($inst_response eq 'ok') {                  ($inst_response,%{$inst_results->{$user}}) =
                         if (keys(%inst_results) == 0) {                      &Apache::lonnet::get_instuser($udom,$uname);
                             if ($caller eq 'new') {                  return;
                                 $response = &mt('The username you chose matches the format of usernames defined for <span class="LC_cusr_emph">[_1]</span>, but the user does not exist in the institutional directory.',$domdesc).'<br />'.&mt("You must choose a username with a different format -- one that will not conflict with 'official' institutional usernames.");              }
                             }              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'};
                         }                          }
                     }                      }
                     last;  
                 }                  }
                   $got_rules->{$udom} = 1;  
             }              }
             if ($response) {              foreach my $item (keys(%{$checks})) {
                 if ((ref($rules) eq 'HASH') && (ref($ruleorder) eq 'ARRAY')) {                  if (ref($$curr_rules{$udom}) eq 'HASH') {
                     if (@{$ruleorder} > 0) {                      if (ref($$curr_rules{$udom}{$item}) eq 'ARRAY') {
                         $response .= '<br />'.&mt('Usernames with the following format(s) may <span class="LC_cusr_emph">only</span> be used for verified users at [_1]:',$domdesc).' <ul>';                          if (@{$$curr_rules{$udom}{$item}} > 0) {
                         foreach my $rule (@{$ruleorder}) {                              my %rule_check = &Apache::lonnet::inst_rulecheck($udom,$uname,$id,$item,$$curr_rules{$udom}{$item});
                             if (grep(/^\Q$rule\E$/,@curr_rules)) {                              foreach my $rule (@{$$curr_rules{$udom}{$item}}) {
                                 if (ref($rules->{$rule}) eq 'HASH') {                                  if ($rule_check{$rule}) {
                                     $response .= '<li>'.$rules->{$rule}{'name'}.': '.                                      $$rulematch{$user}{$item} = $rule;
                                                  $rules->{$rule}{'desc'}.'</li>';                                      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;
                                 }                                  }
                             }                              }
                         }                          }
                     }                      }
                     $response .= '</ul>';  
                 }                  }
             }              }
         }          }
     }      }
     return ($response,$rulematch,$rules,%inst_results);      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',
                      );
       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
Line 6201  sub username_rule_check { Line 7055  sub username_rule_check {
   
 =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 6230  sub get_unprocessed_cgi { Line 7084  sub get_unprocessed_cgi {
   
 =pod  =pod
   
 =item * cacheheader()   =item * &cacheheader() 
   
 returns cache-controlling header code  returns cache-controlling header code
   
Line 6247  sub cacheheader { Line 7101  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 6283  sub content_type { Line 7137  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 6310  sub add_to_env { Line 7164  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 6333  sub get_env_multiple { Line 7187  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 6342  sub get_env_multiple { Line 7422  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 6372  sub upfile_store { Line 7452  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 6396  sub load_tmp_file { Line 7476  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 6418  sub upfile_record_sep { Line 7498  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 6503  sub record_sep { Line 7583  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 6550  sub get_samples { Line 7630  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 6562  Apache Request ref, $records is an array Line 7642  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&nbsp;[_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 6585  sub csv_print_samples { Line 7666  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 6602  sub csv_print_select_table { Line 7683  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.');">');
Line 6615  sub csv_print_select_table { Line 7697  sub csv_print_select_table {
  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 6629  sub csv_print_select_table { Line 7712  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 6645  sub csv_samples_select_table { Line 7728  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 6659  sub csv_samples_select_table { Line 7745  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 6676  sub csv_samples_select_table { Line 7763  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 6695  sub clean_excel_name { Line 7782  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 6736  sub check_if_partid_hidden { Line 7823  sub check_if_partid_hidden {
   
 =over 4  =over 4
   
 =item get_cgi_id  =item * &get_cgi_id()
   
 Inputs: none  Inputs: none
   
Line 6760  sub get_cgi_id { Line 7847  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 6895  sub DrawBarGraph { Line 7982  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 6904  sub DrawBarGraph { Line 7991  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 6985  sub DrawXYGraph { Line 8072  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 6994  sub DrawXYGraph { Line 8081  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 7087  sub DrawXYYGraph { Line 8174  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 7104  Bad place for them but what the hell. Line 8191  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 7143  sub chartlink { Line 8230  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 7165  a hash ref describing the data to be sto Line 8252  a hash ref describing the data to be sto
   
 Returns: both routines return nothing  Returns: both routines return nothing
   
   =back
   
 =cut  =cut
   
 #######################################################  #######################################################
Line 7217  sub store_settings { Line 8306  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 7245  sub restore_settings { Line 8334  sub restore_settings {
     }      }
 }  }
   
   #######################################################
   #######################################################
   
   =pod
   
   =head1 Domain E-mail Routines  
   
   =over 4
   
   =item * &build_recipient_list()
   
   Build recipient lists for three types of e-mail:
   (a) Error Reports, (b) Package Updates, (c) Help requests, generated by
   lonerrorhandler.pm, CHECKRPMS and lonsupportreq.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 (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);
       }
       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 7271  sub commit_standardrole { Line 8768  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 7289  sub commit_standardrole { Line 8786  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 7301  sub commit_standardrole { Line 8798  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 7313  sub commit_studentrole { Line 8810  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 7455  sub construct_course { Line 9007  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'],
                      $$crsudom,$$crsunum);
     }      }
   
 #  #
Line 7495  sub construct_course { Line 9054  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 7555  sub construct_course { Line 9113  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 7695  sub construct_course { Line 9253  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 7752  sub icon { Line 9310  sub icon {
     return &lonhttpdurl($iconname);      return &lonhttpdurl($iconname);
 }   } 
   
 sub lonhttpd_port {  
     my $lonhttpd_port=$Apache::lonnet::perlvar{'lonhttpdPort'};  
     if (!defined($lonhttpd_port)) { $lonhttpd_port='8080'; }  
     # IE doesn't like a secure page getting images from a non-secure  
     # port (when logging we haven't parsed the browser type so default  
     # back to secure  
     if ((!exists($env{'browser.type'}) || $env{'browser.type'} eq 'explorer')  
  && $ENV{'SERVER_PORT'} == 443) {  
  return 443;  
     }  
     return $lonhttpd_port;  
   
 }  
   
 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)=@_;
       return $url;
     my $lonhttpd_port = &lonhttpd_port();  
     if ($lonhttpd_port == 443) {  
  return 'https://'.$ENV{'SERVER_NAME'}.$url;  
     }  
     return 'http://'.$ENV{'SERVER_NAME'}.':'.$lonhttpd_port.$url;  
 }  }
   
 sub connection_aborted {  sub connection_aborted {
Line 7851  sub init_user_environment { Line 9395  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 7966  sub init_user_environment { Line 9510  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-^http://($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) = @_;
   
       &Apache::lonenc::check_decrypt(\$symb);
       my $enc = $env{'request.enc'};
       delete($env{'request.enc'});
   
       return ($symb,$enc);
   }
   
 =pod  =pod
   

Removed from v.1.587  
changed lines
  Added in v.1.692.2.4


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