--- loncom/interface/lonhtmlcommon.pm	2005/10/27 23:13:49	1.116
+++ loncom/interface/lonhtmlcommon.pm	2006/06/01 19:30:49	1.131
@@ -1,7 +1,7 @@
 # The LearningOnline Network with CAPA
 # a pile of common html routines
 #
-# $Id: lonhtmlcommon.pm,v 1.116 2005/10/27 23:13:49 raeburn Exp $
+# $Id: lonhtmlcommon.pm,v 1.131 2006/06/01 19:30:49 albertel Exp $
 #
 # Copyright Michigan State University Board of Trustees
 #
@@ -60,6 +60,8 @@ use Time::Local;
 use Time::HiRes;
 use Apache::lonlocal;
 use Apache::lonnet;
+use lib '/home/httpd/lib/perl/';
+use LONCAPA;
 
 ##############################################
 ##############################################
@@ -93,7 +95,7 @@ sub authorbombs {
 
 sub recent_filename {
     my $area=shift;
-    return 'nohist_recent_'.&Apache::lonnet::escape($area);
+    return 'nohist_recent_'.&escape($area);
 }
 
 sub store_recent {
@@ -115,7 +117,7 @@ sub store_recent {
     }
 # store new value
     &Apache::lonnet::put($file,{ $name => 
-				 time.'&'.&Apache::lonnet::escape($value) });
+				 time.'&'.&escape($value) });
 }
 
 sub remove_recent {
@@ -134,7 +136,7 @@ sub select_recent {
 	unless ($_=~/^error\:/) {
 	    my $escaped = &Apache::loncommon::escape_url($_);
 	    $return.="\n<option value='$escaped'>".
-		&Apache::lonnet::unescape((split(/\&/,$recent{$_}))[1]).
+		&unescape((split(/\&/,$recent{$_}))[1]).
 		'</option>';
 	}
     }
@@ -158,7 +160,7 @@ sub get_recent {
     my $idx = 1;
     foreach (reverse sort keys %time_hash) {
        $return_hash{$time_hash{$_}} =
-                  &Apache::lonnet::unescape((split(/\&/,$recent{$_}))[1]);
+                  &unescape((split(/\&/,$recent{$_}))[1]);
        if ($n && ($idx++ >= $n)) {last;}
     }
 
@@ -178,6 +180,7 @@ sub get_recent {
 sub textbox {
     my ($name,$value,$size,$special) = @_;
     $size = 40 if (! defined($size));
+    $value = &HTML::Entities::encode($value,'<>&"');
     my $Str = '<input type="text" name="'.$name.'" size="'.$size.'" '.
         'value="'.$value.'" '.$special.' />';
     return $Str;
@@ -207,6 +210,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;
+}
+
 ##############################################
 ##############################################
 
@@ -502,7 +527,7 @@ sub get_date_from_form {
     if (($year<70) || ($year>137)) { return undef; }
     if (defined($sec) && defined($min)   && defined($hour) &&
         defined($day) && defined($month) && defined($year) &&
-        eval(&timelocal($sec,$min,$hour,$day,$month,$year))) {
+        eval('&timelocal($sec,$min,$hour,$day,$month,$year)')) {
         return &timelocal($sec,$min,$hour,$day,$month,$year);
     } else {
         return undef;
@@ -781,20 +806,25 @@ sub Create_PrgWin {
     $prog_state{'type'}=$type;
     if ($type eq 'popup') {
 	$prog_state{'window'}='popwin';
-	my $html=&Apache::lonxml::xmlbegin();
+	my $start_page =
+	    &Apache::loncommon::start_page($title,undef,
+					   {'only_body' => 1,
+					    'bgcolor'   => '#88DDFF',
+					    'js_ready'  => 1});
+	my $end_page = &Apache::loncommon::end_page({'js_ready'  => 1});
+
 	#the whole function called through timeout is due to issues
 	#in mozilla Read BUG #2665 if you want to know the whole story
-	&r_print($r,'<script>'.
+	&r_print($r,'<script type="text/javascript">'.
         "var popwin;
          function openpopwin () {
          popwin=open(\'\',\'popwin\',\'width=400,height=100\');".
-        "popwin.document.writeln(\'".$html."<head><title>$title</title></head>".
-	      "<body bgcolor=\"#88DDFF\">".
-              "<h4>$heading</h4>".
-              "<form name=popremain>".
+        "popwin.document.writeln(\'".$start_page.
+              "<h4>$heading<\/h4>".
+              "<form name=\"popremain\" method=\"post\">".
               '<input type="text" size="'.$width.'" name="remaining" value="'.
-	      &mt('Starting').'"></form>'.
-              "</body></html>\');".
+	      &mt('Starting').'" /><\\/form>'.$end_page.
+              "\');".
         "popwin.document.close();}".
         "\nwindow.setTimeout(openpopwin,0)</script>");
 	$prog_state{'formname'}='popremain';
@@ -952,7 +982,14 @@ sub crumbs {
 # --------------------- A function that generates a window for the spellchecker
 
 sub spellheader {
-    my $html=&Apache::lonxml::xmlbegin();
+    my $start_page=
+	&Apache::loncommon::start_page('Speller Suggestions',undef,
+				       {'only_body' => 1,
+					'js_ready'  => 1,
+					'bgcolor'   => '#DDDDDD',});
+    my $end_page=
+	&Apache::loncommon::end_page({'js_ready'  => 1}); 
+
     my $nothing=&javascript_nothing();
     return (<<ENDCHECK);
 <script type="text/javascript"> 
@@ -961,7 +998,7 @@ var checkwin;
 
 function spellcheckerwindow() {
     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.writeln('$start_page<form name="spellcheckform" action="/adm/spellcheck" method="post"><input type="hidden" name="text" value="" /><\\/form>$end_page');
     checkwin.document.close();
 }
 // END LON-CAPA Internal -->
@@ -981,6 +1018,22 @@ ENDLINK
 
 # ------------------------------------------------- Output headers for HTMLArea
 
+{
+    my @htmlareafields;
+    sub init_htmlareafields {
+	undef(@htmlareafields);
+    }
+    
+    sub add_htmlareafields {
+	my (@newfields) = @_;
+	push(@htmlareafields,@newfields);
+    }
+
+    sub get_htmlareafields {
+	return @htmlareafields;
+    }
+}
+
 sub htmlareaheaders {
     if (&htmlareablocked()) { return ''; }
     unless (&htmlareabrowser()) { return ''; }
@@ -1028,7 +1081,7 @@ sub disablelink {
     if (defined($#fields)) {
 	unless ($#fields>=0) { return ''; }
     }
-    return '<a href="'.&HTML::Entities::encode('/adm/preferences?action=set_wysiwyg&wysiwyg=off&returnurl=','<>&"').&Apache::lonnet::escape($ENV{'REQUEST_URI'}).'">'.&mt('Disable WYSIWYG Editor').'</a>';
+    return '<a href="'.&HTML::Entities::encode('/adm/preferences?action=set_wysiwyg&wysiwyg=off&returnurl=','<>&"').&escape($ENV{'REQUEST_URI'}).'">'.&mt('Disable WYSIWYG Editor').'</a>';
 }
 
 sub enablelink {
@@ -1036,7 +1089,7 @@ sub enablelink {
     if (defined($#fields)) {
 	unless ($#fields>=0) { return ''; }
     }
-    return '<a href="'.&HTML::Entities::encode('/adm/preferences?action=set_wysiwyg&wysiwyg=on&returnurl=','<>&"').&Apache::lonnet::escape($ENV{'REQUEST_URI'}).'">'.&mt('Enable WYSIWYG Editor').'</a>';
+    return '<a href="'.&HTML::Entities::encode('/adm/preferences?action=set_wysiwyg&wysiwyg=on&returnurl=','<>&"').&escape($ENV{'REQUEST_URI'}).'">'.&mt('Enable WYSIWYG Editor').'</a>';
 }
 
 # ----------------------------------------- Script to activate only some fields
@@ -1115,20 +1168,9 @@ returns: nothing
     my @Crumbs;
     
     sub breadcrumbs {
-        my ($color,$component,$component_help,$function,$domain,$menulink,
-	    $helplink) = @_;
-        if (! defined($color)) {
-            if (! defined($function)) {
-                $function = &Apache::loncommon::get_users_function();
-            }
-            $color = &Apache::loncommon::designparm($function.'.tabbg',
-                                                    $domain);
-        }
+        my ($component,$component_help,$menulink,$helplink) = @_;
         #
-        my $Str = "\n".
-            '<table width="100%" border="0" cellpadding="0" cellspacing="0">'.
-            '<tr><td bgcolor="'.$color.'">'.
-            '<font size="-1">';
+        my $Str = "\n".'<table id="LC_breadcrumbs"><tr><td>';
         #
         # Make the faq and bug data cascade
         my $faq = '';
@@ -1183,17 +1225,19 @@ returns: nothing
 #            $icons .= &Apache::loncommon::help_open_bug($bug);
 #        }
 	if ($helplink ne 'nohelp') {
-	    $icons .= &Apache::loncommon::help_open_menu($color,$component,$component_help,$function,$faq,$bug);
+	    $icons .= &Apache::loncommon::help_open_menu(undef,$component,
+							 $component_help,
+							 undef,$faq,$bug);
 	}
         if ($icons ne '') {
             $Str .= $icons.'&nbsp;';
         }
         #
-        $Str .= $links.'</font></td>';
+        $Str .= $links.'</td>';
         #
         if (defined($component)) {
-            $Str .= '<td align="right" bgcolor="'.$color.'">'.
-                '<font size="+1">'.&mt($component).'</font></td>';
+            $Str .= '<td class="LC_breadcrumb_component">'.
+                &mt($component).'</td>';
         }
         $Str .= '</tr></table>'."\n";
         #
@@ -1337,7 +1381,7 @@ sub role_select_row {
     if (defined($title)) {
         $output = &row_title($col_width,$tablecolor,$title);
     }
-    $output .= qq|               <td>
+    $output .= qq|               <td valign="top">
                                   <select name="roles" multiple >\n|;
     foreach my $role (@$roles) {
         my $plrole;
@@ -1387,12 +1431,12 @@ sub course_select_row {
 </script>
     |;
     my $courseform='<b>'.&Apache::loncommon::selectcourse_link
-                     ($formname,'pickcourse','pickdomain','coursedesc').'</b>';
+                     ($formname,'pickcourse','pickdomain','coursedesc','',1).'</b>';
+        $output .= '<input type="radio" name="coursepick" value="all" onclick="coursePick(this.form)" />'.&mt('All courses').'<br />';
     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 .= '<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".
@@ -1433,22 +1477,27 @@ sub course_select_row {
             $output .= '</tr></table><br />';
         }
     }
-    $output .= '<input type="radio" name="coursepick" value="specific" onclick="coursePick(this.form);opencrsbrowser('."'".'rolefilter'."'".','."'".'dccourse'."'".','."'".'dcdomain'."'".','."'".'coursedesc'."',''".')" />'.&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 .= '<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 = &row_title($col_width,$tablecolor,$title);
-    $output .= qq|              <td>
+    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|; 
-    $output .= &row_closure();
+    if (defined($title)) {
+        $output .= &row_closure();
+    }
     return $output;
 }
 
@@ -1495,6 +1544,218 @@ sub submit_row {
     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;
 
 __END__