--- loncom/interface/lonhtmlcommon.pm	2005/04/07 06:56:23	1.104
+++ loncom/interface/lonhtmlcommon.pm	2006/02/22 19:22:49	1.121
@@ -1,7 +1,7 @@
 # The LearningOnline Network with CAPA
 # a pile of common html routines
 #
-# $Id: lonhtmlcommon.pm,v 1.104 2005/04/07 06:56:23 albertel Exp $
+# $Id: lonhtmlcommon.pm,v 1.121 2006/02/22 19:22:49 raeburn Exp $
 #
 # Copyright Michigan State University Board of Trustees
 #
@@ -100,7 +100,7 @@ sub store_recent {
     my ($area,$name,$value)=@_;
     my $file=&recent_filename($area);
     my %recent=&Apache::lonnet::dump($file);
-    if (scalar(keys(%recent))>10) {
+    if (scalar(keys(%recent))>20) {
 # remove oldest value
 	my $oldest=time;
 	my $delkey='';
@@ -207,6 +207,28 @@ sub checkbox {
     return $Str;
 }
 
+
+=pod
+
+=item radiobutton
+
+=cut
+
+##############################################
+##############################################
+sub radio {
+    my ($name,$checked,$value) = @_;
+    my $Str = '<input type="radio" name="'.$name.'" ';
+    if (defined($value)) {
+        $Str .= 'value="'.$value.'"';
+    } 
+    if ($checked eq $value) {
+        $Str .= ' checked="1"';
+    }
+    $Str .= ' />';
+    return $Str;
+}
+
 ##############################################
 ##############################################
 
@@ -258,18 +280,23 @@ The method used to restrict user input w
 ##############################################
 sub date_setter {
     my ($formname,$dname,$currentvalue,$special,$includeempty,$state,
-        $no_hh_mm_ss) = @_;
+        $no_hh_mm_ss,$defhour,$defmin,$defsec) = @_;
+    my $wasdefined=1;
     if (! defined($state) || $state ne 'disabled') {
         $state = '';
     }
     if (! defined($no_hh_mm_ss)) {
         $no_hh_mm_ss = 0;
     }
-    if (! defined($currentvalue) || $currentvalue eq 'now') {
-	unless ($includeempty) {
-	    $currentvalue = time;
-	} else {
+    if ($currentvalue eq 'now') {
+	$currentvalue=time;
+    }
+    if ((!defined($currentvalue)) || ($currentvalue eq '')) {
+	$wasdefined=0;
+	if ($includeempty) {
 	    $currentvalue = 0;
+	} else {
+	    $currentvalue = time;
 	}
     }
     # other potentially useful values:     wkday,yrday,is_daylight_savings
@@ -279,6 +306,20 @@ sub date_setter {
 	    localtime($currentvalue);
 	$year += 1900;
     }
+    unless ($wasdefined) {
+	if (($defhour) || ($defmin) || ($defsec)) {
+	    ($sec,$min,$hour,$mday,$month,$year,undef,undef,undef) = 
+		localtime(time);
+	    $year += 1900;
+	    $sec=($defsec?$defsec:0);
+	    $min=($defmin?$defmin:0);
+	    $hour=($defhour?$defhour:0);
+	} elsif (!$includeempty) {
+	    $sec=0;
+	    $min=0;
+	    $hour=0;
+	}
+    }
     my $result = "\n<!-- $dname date setting form -->\n";
     $result .= <<ENDJS;
 <script language="Javascript">
@@ -506,11 +547,13 @@ parameter setting wizard.
 ##############################################
 sub pjump_javascript_definition {
     my $Str = <<END;
-    function pjump(type,dis,value,marker,ret,call) {
+    function pjump(type,dis,value,marker,ret,call,hour,min,sec) {
         parmwin=window.open("/adm/rat/parameter.html?type="+escape(type)
                  +"&value="+escape(value)+"&marker="+escape(marker)
                  +"&return="+escape(ret)
-                 +"&call="+escape(call)+"&name="+escape(dis),"LONCAPAparms",
+                 +"&call="+escape(call)+"&name="+escape(dis)
+                 +"&defhour="+escape(hour)+"&defmin="+escape(min)
+                 +"&defsec="+escape(sec),"LONCAPAparms",
                  "height=350,width=350,scrollbars=no,menubar=no");
     }
 END
@@ -932,13 +975,14 @@ sub crumbs {
 
 sub spellheader {
     my $html=&Apache::lonxml::xmlbegin();
+    my $nothing=&javascript_nothing();
     return (<<ENDCHECK);
 <script type="text/javascript"> 
 //<!-- BEGIN LON-CAPA Internal
 var checkwin;
 
 function spellcheckerwindow() {
-    checkwin=window.open('/adm/rat/empty.html','spellcheckwin','height=320,width=280,resizable=yes,scrollbars=yes,location=no,menubar=no,toolbar=no');
+    checkwin=window.open($nothing,'spellcheckwin','height=320,width=280,resizable=yes,scrollbars=yes,location=no,menubar=no,toolbar=no');
     checkwin.document.writeln('$html<head></head><body bgcolor="#DDDDDD"><form name="spellcheckform" action="/adm/spellcheck" method="post"><input type="hidden" name="text" value="" /></form></body></html>');
     checkwin.document.close();
 }
@@ -953,7 +997,7 @@ sub spelllink {
     my ($form,$field)=@_;
     my $linktext=&mt('Check Spelling');
     return (<<ENDLINK);
-<a href="javascript:if (typeof(document.$form.onsubmit)!='undefined') { document.$form.onsubmit();};spellcheckerwindow();checkwin.document.forms.spellcheckform.text.value=this.document.forms.$form.$field.value;checkwin.document.forms.spellcheckform.submit();">$linktext</a>
+<a href="javascript:if (typeof(document.$form.onsubmit)!='undefined') { if (document.$form.onsubmit!=null) { document.$form.onsubmit();}};spellcheckerwindow();checkwin.document.forms.spellcheckform.text.value=this.document.forms.$form.$field.value;checkwin.document.forms.spellcheckform.submit();">$linktext</a>
 ENDLINK
 }
 
@@ -1111,6 +1155,7 @@ returns: nothing
         # Make the faq and bug data cascade
         my $faq = '';
         my $bug = '';
+	my $help='';
         # The last breadcrumb does not have a link, so handle it separately.
         my $last = pop(@Crumbs);
         #
@@ -1135,6 +1180,7 @@ returns: nothing
                  map {
                      $faq = $_->{'faq'} if (exists($_->{'faq'}));
                      $bug = $_->{'bug'} if (exists($_->{'bug'}));
+                     $help = $_->{'help'} if (exists($_->{'help'}));
                      my $result = '<a href="'.$_->{'href'}.'" ';
                      if (defined($_->{'target'}) && $_->{'target'} ne '') {
                          $result .= 'target="'.$_->{'target'}.'" ';
@@ -1150,6 +1196,8 @@ returns: nothing
         my $icons = '';
         $faq = $last->{'faq'} if (exists($last->{'faq'}));
         $bug = $last->{'bug'} if (exists($last->{'bug'}));
+        $help = $last->{'help'} if (exists($last->{'help'}));
+        $component_help=($component_help?$component_help:$help);
 #        if ($faq ne '') {
 #            $icons .= &Apache::loncommon::help_open_faq($faq);
 #        }
@@ -1191,6 +1239,500 @@ returns: nothing
 ############################################################
 ############################################################
 
+# Nested table routines.
+#
+# Routines to display form items in a multi-row table with 2 columns.
+# Uses nested tables to divide form elements into segments.
+# For examples of use see loncom/interface/lonnotify.pm 
+#
+# Can be used in following order: ...
+# &start_pick_box()
+# row1
+# row2
+# row3   ... etc.
+# &submit_row(0
+# &end_pickbox()
+#
+# where row1, row 2 etc. are chosen from &role_select_row,&course_select_row,
+# &status_select_row and &email_default_row
+#
+# Can also be used in following order:
+#
+# &start_pick_box()
+# &row_title()
+# &row_closure()
+# &row_title()
+# &row_closure()  ... etc.
+# &submit_row()
+# &end_pick_box()
+#
+# In general a &submit_row() call should proceed the call to &end_pick_box(),
+# as this routine adds a button for form submission.
+# &submit_row() does not require a &row_closure after it.
+#  
+# &start_pick_box() creates a bounding table with 1-pixel wide black border.
+# rows should be placed between calls to &start_pick_box() and &end_pick_box.
+#
+# &row_title() adds a title in the left column for each segment.
+# &row_closure() closes a row with a 1-pixel wide black line.
+#
+# &role_select_row() provides a select box from which to choose 1 or more roles 
+# &course_select_row provides ways of picking groups of courses
+#    radio buttons: all, by category or by picking from a course picker pop-up
+#      note: by category option is only displayed if a domain has implemented 
+#                selection by year, semester, department, number etc.
+#
+# &status_select_row() provides a select box from which to choose 1 or more
+#  access types (current access, prior access, and future access)  
+#
+# &email_default_row() provides text boxes for default e-mail suffixes for
+#  different authentication types in a domain.
+#
+# &row_title() and &row_closure() are called internally by the &*_select_row
+# routines, but can also be called directly to start and end rows which have 
+# needs that are not accommodated by the *_select_row() routines.    
+
+sub start_pick_box {
+    my ($table_width) = @_;
+    my $output = <<"END";
+ <table width="$table_width" border="0" cellpadding="0" cellspacing="1" bgcolor="#000000">
+  <tr>
+      <td>
+       <table width="100%" border="0" cellpadding="0" cellspacing="0" bgcolor="#ffffff">
+        <tr>
+         <td>
+          <table width="100%" border="0" cellpadding="0" cellspacing="1" bgcolor="#ffffff">
+END
+    return $output;
+}
+
+sub end_pick_box {
+    my $output = <<"END";
+       </table>
+      </td>
+     </tr>
+    </table>
+   </td>
+  </tr>
+ </table>
+END
+    return $output;
+}
+
+sub row_title {
+    my ($col_width,$tablecolor,$title) = @_;
+    my $output = <<"ENDONE";
+           <tr>
+            <td width="$col_width" bgcolor="$tablecolor">
+             <table width="$col_width" border="0" cellpadding="8" cellspacing="0">
+              <tr>
+               <td align="right"><b>$title:</b>
+               </td>
+              </tr>
+             </table>
+            </td>
+            <td width="100%" valign="top">
+             <table width="100%" border="0" cellpadding="8" cellspacing="0">
+              <tr>
+ENDONE
+    return $output;
+}
+
+sub row_closure {
+    my $output = <<"ENDTWO";
+              </tr>
+             </table>
+            </td>
+           </tr>
+           <tr>
+            <td width="100%" colspan="2" bgcolor="#000000">
+             <img src="/adm/lonMisc/blackdot.gif" /><br />
+            </td>
+           </tr>
+ENDTWO
+    return $output;
+}
+
+sub role_select_row {
+    my ($roles,$col_width,$tablecolor,$title) = @_;
+    my $output;
+    if (defined($title)) {
+        $output = &row_title($col_width,$tablecolor,$title);
+    }
+    $output .= qq|               <td valign="top">
+                                  <select name="roles" multiple >\n|;
+    foreach my $role (@$roles) {
+        my $plrole;
+        if ($role eq 'ow') {
+            $plrole = &mt('Course Owner');
+        } else {
+            $plrole=&Apache::lonnet::plaintext($role);
+        }
+        $output .= '  <option value="'.$role.'">'.$plrole.'</option>';
+    }
+    $output .= qq|                </select>
+                                 </td>\n|;
+    if (defined($title)) {
+        $output .= &row_closure();
+    }
+    return $output;
+}
+
+sub course_select_row {
+    my ($col_width,$tablecolor,$title,$formname,$totcodes,$codetitles,$idlist,$idlist_titles) = @_;
+    my $output = &row_title($col_width,$tablecolor,$title);
+    $output .= "          <td>\n";
+    $output .= qq|
+<script type="text/javascript" language="Javascript" >
+    function coursePick (formname) {
+        for  (var i=0; i<formname.coursepick.length; i++) {
+            if (formname.coursepick[i].value == 'category') {
+                courseSet('');
+            }
+            if (!formname.coursepick[i].checked) {
+                if (formname.coursepick[i].value == 'specific') {
+                    formname.coursetotal.value = 0;
+                    formname.courselist = '';
+                }
+            }
+        }
+    }
+    function setPick (formname) {
+        for  (var i=0; i<formname.coursepick.length; i++) {
+            if (formname.coursepick[i].value == 'category') {
+                formname.coursepick[i].checked = true;
+            }
+            formname.coursetotal.value = 0;
+            formname.courselist = '';
+        }
+    }
+</script>
+    |;
+    my $courseform='<b>'.&Apache::loncommon::selectcourse_link
+                     ($formname,'pickcourse','pickdomain','coursedesc','',1).'</b>';
+    if ($totcodes > 0) {
+        $output .= '<input type="radio" name="coursepick" value="all" onclick="coursePick(this.form)" />'.&mt('All courses');
+        my $numtitles = @$codetitles;
+        if ($numtitles > 0) {
+            $output .= '<br /><input type="radio" name="coursepick" value="category" onclick="coursePick(this.form);alert('."'".&mt('Choose categories, from left to right')."'".')" />'.&mt('Pick courses by category:').' <br />';
+            $output .= '<table><tr><td>'.$$codetitles[0].'<br />'."\n".
+               '<select name="'.$$codetitles[0].
+               '" onChange="setPick(this.form);courseSet('."'$$codetitles[0]'".')">'."\n".
+               ' <option value="-1" />Select'."\n";
+            my @items = ();
+            my @longitems = ();
+            if ($$idlist{$$codetitles[0]} =~ /","/) {
+                @items = split(/","/,$$idlist{$$codetitles[0]});
+            } else {
+                $items[0] = $$idlist{$$codetitles[0]};
+            }
+            if (defined($$idlist_titles{$$codetitles[0]})) {
+                if ($$idlist_titles{$$codetitles[0]} =~ /","/) {
+                    @longitems = split(/","/,$$idlist_titles{$$codetitles[0]});
+                } else {
+                    $longitems[0] = $$idlist_titles{$$codetitles[0]};
+                }
+                for (my $i=0; $i<@longitems; $i++) {
+                    if ($longitems[$i] eq '') {
+                        $longitems[$i] = $items[$i];
+                    }
+                }
+            } else {
+                @longitems = @items;
+            }
+            for (my $i=0; $i<@items; $i++) {
+                $output .= ' <option value="'.$items[$i].'">'.$longitems[$i].'</option>';
+            }
+            $output .= '</select></td>';
+            for (my $i=1; $i<$numtitles; $i++) {
+                $output .= '<td>'.$$codetitles[$i].'<br />'."\n".
+                          '<select name="'.$$codetitles[$i].
+                          '" onChange="courseSet('."'$$codetitles[$i]'".')">'."\n".
+                          '<option value="-1">&lt;-Pick '.$$codetitles[$i-1].'</option>'."\n".
+                          '</select>'."\n".
+                          '</td>';
+            }
+            $output .= '</tr></table><br />';
+        }
+    }
+    $output .= '<input type="radio" name="coursepick" value="specific" onclick="coursePick(this.form);opencrsbrowser('."'".$formname."'".','."'".'dccourse'."'".','."'".'dcdomain'."'".','."'".'coursedesc'."','','1'".')" />'.&mt('Pick specific course(s):').' '.$courseform.'&nbsp;&nbsp;<input type="text" value="0" size="4" name="coursetotal" /><input type="hidden" name="courselist" value="" />selected.<br /></td>'."\n";
+    $output .= &row_closure();
+    return $output;
+}
+
+sub status_select_row {
+    my ($types,$col_width,$tablecolor,$title) = @_;
+    my $output; 
+    if (defined($title)) {
+        $output = &row_title($col_width,$tablecolor,$title);
+    }
+    $output .= qq|              <td valign="top">
+                                    <select name="types" multiple>\n|;
+    foreach my $status_type (sort(keys(%{$types}))) {
+        $output .= '  <option value="'.$status_type.'">'.$$types{$status_type}.'</option>';
+    }
+    $output .= qq|                   </select>
+                                    </td>\n|; 
+    if (defined($title)) {
+        $output .= &row_closure();
+    }
+    return $output;
+}
+
+sub email_default_row {
+    my ($authtypes,$col_width,$tablecolor,$title,$descrip) = @_;
+    my $output = &row_title($col_width,$tablecolor,$title);
+    my @rowcols = ('#eeeeee','#dddddd');
+    $output .= '              <td>'.$descrip;
+    $output .= &start_pick_box(''); 
+    $output .= '                <tr bgcolor="'.$tablecolor.'">
+                                 <td><b>'.&mt('Authentication Method').'</b></td><td align="right"><b>'.&mt('Username -> e-mail conversion').'</b></td>
+                                </tr>'."\n";
+    my $rownum = 0;
+    foreach my $auth (sort(keys(%{$authtypes}))) {
+        my ($userentry,$size);
+        my $rowiter = $rownum%2;
+        if ($auth =~ /^krb/) {
+            $userentry = '';
+            $size = 25;
+        } else {
+            $userentry = 'username@';
+            $size = 15;
+        }
+        $output .= '<tr bgcolor="'.$rowcols[$rowiter].'"><td>  '.$$authtypes{$auth}.'</td><td align="right">'.$userentry.'<input type="text" name="'.$auth.'" size="'.$size.'" /></td></tr>';
+        $rownum ++;
+    }
+    $output .= &end_pick_box();
+    $output .= "                   <br /></td>\n"; 
+    $output .= &row_closure();
+    return $output;
+}
+
+
+sub submit_row {
+    my ($col_width,$tablecolor,$title,$cmd,$submit_text) = @_;
+    my $output = &row_title($col_width,$tablecolor,$title);
+    $output .= qq|
+            <td width="100%" valign="top" align="right">
+             <br />
+             <input type="hidden" name="command" value="$cmd" />
+             <input type="submit" value="$submit_text"/> &nbsp;
+             <br /><br />
+            </td>\n|;
+    return $output;
+}
+
+##############################################
+##############################################
+                                                                             
+# echo_form_input
+#
+# Generates html markup to add form elements from the referrer page
+# as hidden form elements (values encoded) in the new page.
+#
+# Intended to support two types of use 
+# (a) to allow backing up to earlier pages in a multi-page 
+# form submission process using a breadcrumb trail.
+#
+# (b) to allow the current page to be reloaded with form elements
+# set on previous page to remain unchanged.  An example would
+# be where the a page containing a dynamically-built table of data is 
+# is to be redisplayed, with only the sort order of the data changed. 
+#  
+# Inputs:
+# 1. Reference to array of form elements in the submitted form on 
+# the referrer page which are to be excluded from the echoed elements.
+#
+# 2. Reference to array of regular expressions, which if matched in the  
+# name of the form element n the referrer page will be omitted from echo. 
+#
+# Outputs: A scalar containing the html markup for the echoed form
+# elements (all as hidden elements, with values encoded). 
+
+
+sub echo_form_input {
+    my ($excluded,$regexps) = @_;
+    my $output = '';
+    foreach my $key (keys(%env)) {
+        if ($key =~ /^form\.(.+)$/) {
+            my $name = $1;
+            my $match = 0;
+            if ((!@{$excluded}) || (!grep/^$name$/,@{$excluded})) {
+                if (defined($regexps)) {
+                    if (@{$regexps} > 0) {
+                        foreach my $regexp (@{$regexps}) {
+                            if ($name =~ /\Q$regexp\E/) {
+                                $match = 1;
+                                last;
+                            }
+                        }
+                    }
+                }
+                if (!$match) {
+                    if (ref($env{$key})) {
+                        foreach my $value (@{$env{$key}}) {
+                            $value = &HTML::Entities::encode($value,'<>&"');
+                            $output .= '<input type="hidden" name="'.$name.
+                                             '" value="'.$value.'" />'."\n";
+                        }
+                    } else {
+                        my $value = &HTML::Entities::encode($env{$key},'<>&"');
+                        $output .= '<input type="hidden" name="'.$name.
+                                             '" value="'.$value.'" />'."\n";
+                    }
+                }
+            }
+        }
+    }
+    return $output;
+}
+
+##############################################
+##############################################
+                                                                             
+# set_form_elements
+#
+# Generates javascript to set form elements to values based on
+# corresponding values for the same form elements when the page was
+# previously submitted.
+#     
+# Last submission values are read from hidden form elements in referring 
+# page which have the same name, i.e., generated by &echo_form_input(). 
+#
+# Intended to be called by onload event.
+#
+# Inputs:
+# (a) Reference to hash of echoed form elements to be set.
+#
+# In the hash, keys are the form element names, and the values are the
+# element type (selectbox, radio, checkbox or text -for textbox, textarea or
+# hidden).
+#
+# (b) Optional reference to hash of stored elements to be set.
+#
+# If the page being displayed is a page which permits modification of
+# previously stored data, e.g., the first page in a multi-page submission,
+# then if stored is supplied, form elements will be set to the last stored
+# values.  If user supplied values are also available for the same elements
+# these will replace the stored values. 
+#        
+# Output:
+#  
+# javascript function - set_form_elements() which sets form elements,
+# expects an argument: formname - the name of the form according to 
+# the DOM, e.g., document.compose
+
+sub set_form_elements {
+    my ($elements,$stored) = @_;
+    my %values;
+    my $output .= 'function setFormElements(courseForm) {
+';
+    if (defined($stored)) {
+        foreach my $name (keys(%{$stored})) {
+            if (exists($$elements{$name})) {
+                if (ref($$stored{$name}) eq 'ARRAY') {
+                    $values{$name} = $$stored{$name};
+                } else {
+                    @{$values{$name}} = ($$stored{$name});
+                }
+            }
+        }
+    }
+
+    foreach my $key (keys(%env)) {
+        if ($key =~ /^form\.(.+)$/) {
+            my $name = $1;
+            if (exists($$elements{$name})) {
+                @{$values{$name}} = &Apache::loncommon::get_env_multiple($key);
+            }
+        }
+    }
+
+    foreach my $name (keys(%values)) {
+        for (my $i=0; $i<@{$values{$name}}; $i++) {
+            $values{$name}[$i] = &HTML::Entities::decode($values{$name}[$i],'<>&"');
+            $values{$name}[$i] =~ s/([\r\n\f]+)/\\n/g;
+            $values{$name}[$i] =~ s/"/\\"/g;
+        }
+        if ($$elements{$name} eq 'text') {
+            my $numvalues = @{$values{$name}};
+            if ($numvalues > 1) {
+                my $valuestring = join('","',@{$values{$name}});
+                $output .= qq|
+  var textvalues = new Array ("$valuestring");
+  var total = courseForm.$name.length;
+  if (total > $numvalues) {
+      total = $numvalues;
+  }    
+  for (var i=0; i<total; i++) {
+      courseForm.$name\[i].value = textvalues[i];
+  }
+|;
+            } else {
+                $output .= qq|
+  courseForm.$name.value = "$values{$name}[0]";
+|;
+            }
+        } else {
+            $output .=  qq|
+  var elementLength = courseForm.$name.length;
+  if (elementLength==undefined) {
+|;
+            foreach my $value (@{$values{$name}}) {
+                if ($$elements{$name} eq 'selectbox') {
+                    $output .=  qq|
+      if (courseForm.$name.options[0].value == "$value") {
+          courseForm.$name.options[0].selected = true;
+      }|;
+                } elsif (($$elements{$name} eq 'radio') ||
+                         ($$elements{$name} eq 'checkbox')) {
+                    $output .= qq|
+      if (courseForm.$name.value == "$value") {
+          courseForm.$name.checked = true;
+      }|;
+                }
+            }
+            $output .= qq|
+  }
+  else {
+      for (var i=0; i<courseForm.$name.length; i++) {
+|;
+            if ($$elements{$name} eq 'selectbox') {
+                $output .=  qq|
+          courseForm.$name.options[i].selected = false;|;
+            } elsif (($$elements{$name} eq 'radio') || 
+                     ($$elements{$name} eq 'checkbox')) {
+                $output .= qq|
+          courseForm.$name\[i].checked = false;|; 
+            }
+            $output .= qq|
+      }
+      for (var j=0; j<courseForm.$name.length; j++) {
+|;
+            foreach my $value (@{$values{$name}}) {
+                if ($$elements{$name} eq 'selectbox') {
+                    $output .=  qq|
+          if (courseForm.$name.options[j].value == "$value") {
+              courseForm.$name.options[j].selected = true;
+          }|;
+                } elsif (($$elements{$name} eq 'radio') ||
+                         ($$elements{$name} eq 'checkbox')) { 
+                      $output .= qq|
+          if (courseForm.$name\[j].value == "$value") {
+              courseForm.$name\[j].checked = true;
+          }|;
+                }
+            }
+            $output .= qq|
+      }
+  }
+|;
+        }
+    }
+    $output .= "
+}\n";
+    return $output;
+}
 
 1;