--- loncom/interface/lonhtmlcommon.pm	2003/03/10 20:21:45	1.17
+++ loncom/interface/lonhtmlcommon.pm	2003/06/11 14:20:29	1.23
@@ -1,7 +1,7 @@
 # The LearningOnline Network with CAPA
 # a pile of common html routines
 #
-# $Id: lonhtmlcommon.pm,v 1.17 2003/03/10 20:21:45 matthew Exp $
+# $Id: lonhtmlcommon.pm,v 1.23 2003/06/11 14:20:29 matthew Exp $
 #
 # Copyright Michigan State University Board of Trustees
 #
@@ -65,6 +65,9 @@ use strict;
 
 =item &date_setter
 
+&date_setter returns html and javascript for a compact date-setting form.
+To retrieve values from it, use &get_date_from_form().
+
 Inputs
 
 =over 4
@@ -82,6 +85,12 @@ The current setting for this time parame
 An undefined value is taken to indicate the value is the current time.
 Also, to be explicit, a value of 'now' also indicates the current time.
 
+=back
+
+Bugs
+
+The method used to restrict user input will fail in the year 2400.
+
 =cut
 
 ##############################################
@@ -177,8 +186,12 @@ ENDJS
 ##############################################
 ##############################################
 
+=pod
+
 =item &get_date_from_form
 
+get_date_from_form retrieves the date specified in an &date_setter form.
+
 Inputs:
 
 =over 4
@@ -251,6 +264,33 @@ sub get_date_from_form {
 
 =pod
 
+=item &pjump_javascript_definition()
+
+Returns javascript defining the 'pjump' function, which opens up a
+parameter setting wizard.
+
+=cut
+
+##############################################
+##############################################
+sub pjump_javascript_definition {
+    my $Str = <<END;
+    function pjump(type,dis,value,marker,ret,call) {
+        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",
+                 "height=350,width=350,scrollbars=no,menubar=no");
+    }
+END
+    return $Str;
+}
+
+##############################################
+##############################################
+
+=pod
+
 =item &javascript_nothing()
 
 Return an appropriate null for the users browser.  This is used
@@ -272,187 +312,47 @@ sub javascript_nothing {
         (undef,$user_browser,undef,undef,undef,$user_os) = 
                            &Apache::loncommon::decode_user_agent();
     }
-    &Apache::lonnet::logthis(" os      = :".$user_os.":");
-    &Apache::lonnet::logthis(" browser = :".$user_browser.":");
     if ($user_browser eq 'explorer' && $user_os =~ 'mac') {
         $nothing = "'javascript:void(0);'";
     }
     return $nothing;
 }
 
+
 ##############################################
 ##############################################
 
+=pod
 
+=item &StatusOptions()
 
-sub AscendOrderOptions {
-    my ($order, $page, $formName)=@_;
-
-    my $OpSel1 = '';
-    my $OpSel2 = '';
-
-    if($order eq 'Ascending') {
-        $OpSel1 = ' selected';
-    } else {
-        $OpSel2 = ' selected';
-    }
-
-    my $Str = '';
-    $Str .= '<select name="'.(($page)?$page:'').'Ascend"';
-    if($formName) {
-        $Str .= ' onchange="document.'.$formName.'.submit()"';
-    }
-    $Str .= '>'."\n";
-    $Str .= '<option'.$OpSel1.'>Ascending</option>'."\n".
-	    '<option'.$OpSel2.'>Descending</option>'."\n";
-    $Str .= '</select>'."\n";
-
-    return $Str;
-}
-
-sub MapOptions {
-    my ($data, $page, $formName)=@_;
-    my $Str = '';
-    $Str .= '<select name="';
-    $Str .= (($page)?$page:'').'Maps"';
-    if($formName) {
-        $Str .= ' onchange="document.'.$formName.'.submit()"';
-    }
-    $Str .= '>'."\n";
-
-    my $selected = 0;
-    foreach my $sequence (split(':',$data->{'orderedSequences'})) {
-	$Str .= '<option';
-        if($data->{$page.'Maps'} eq $data->{$sequence.':title'}) {
-            $Str .= ' selected';
-            $selected = 1;
-        }
-	$Str .= '>'.$data->{$sequence.':title'}.'</option>'."\n";	     
-    }
-    $Str .= '<option';
-    if(!$selected) {
-        $Str .= ' selected';
-    }
-    $Str .= '>All Maps</option>'."\n";
-
-    $Str .= '</select>'."\n";
-
-    return $Str;
-}
-
-sub ProblemOptions {
-    my ($data, $page, $map, $formName)=@_;
-    my $Str = '';
-    $Str .= '<select name="';
-    $Str .= (($page)?$page:'').'ProblemSelect"';
-    if($formName) {
-        $Str .= ' onchange="document.'.$formName.'.submit()"';
-    }
-    $Str .= '>'."\n";
-
-    my $selected = 0;
-    foreach my $sequence (split(':',$data->{'orderedSequences'})) {
-	if($data->{$sequence.':title'} eq $map || $map eq 'All Maps') {
-	    foreach my $problem (split(':', $data->{$sequence.':problems'})) {
-		$Str .= '<option';
-		if($data->{$page.'ProblemSelect'} eq 
-		   $data->{$problem.':title'}) {
-		    $Str .= ' selected';
-		    $selected = 1;
-		}
-		$Str .= '>'.$data->{$problem.':title'}.'</option>'."\n";
-	    }
-	}
-    }
-    $Str .= '<option';
-    if(!$selected) {
-        $Str .= ' selected';
-    }
-    $Str .= '>All Problems</option>'."\n";
-
-    $Str .= '</select>'."\n";
-
-    return $Str;
-}
-
-sub PartOptions {
-    my ($data, $page, $parts, $formName)=@_;
-    my $Str = '';
-
-    if(!defined($parts)) {
-	return '';
-    }
-
-    $Str .= '<select name="';
-    $Str .= (($page)?$page:'').'PartSelect"';
-    if($formName) {
-        $Str .= ' onchange="document.'.$formName.'.submit()"';
-    }
-    $Str .= '>'."\n";
-
-    my $selected = 0;
-    foreach my $part (@$parts) {
-	$Str .= '<option';
-	if($data->{$page.'PartSelect'} eq $part) {
-	    $Str .= ' selected';
-	    $selected = 1;
-	}
-	$Str .= '>'.$part.'</option>'."\n";	     
-    }
-    $Str .= '<option';
-    if(!$selected) {
-        $Str .= ' selected';
-    }
-    $Str .= '>All Parts</option>'."\n";
-
-    $Str .= '</select>'."\n";
-
-    return $Str;
-}
-
-sub StudentOptions {
-    my ($cache, $students, $selectedName, $page, $formName)=@_;
+Returns html for a selection box which allows the user to choose the
+enrollment status of students.  The selection box name is 'Status'.
 
-    my $Str = '';
-    $Str .= '<select name="'.(($page)?$page:'').'Student"';
-    if($formName) {
-        $Str .= ' onchange="document.'.$formName.'.submit()"';
-    }
-    $Str .= '>'."\n";
+Inputs:
 
-    my $selected=0;
+$status: the currently selected status.  If undefined the value of
+$ENV{'form.Status'} is taken.  If that is undefined, a value of 'Active'
+is used.
 
-    foreach (@$students) {
-	$Str .= '<option';
-	if($selectedName eq $_) {
-            $Str .= ' selected';
-            $selected = 1;
-        }
-        $Str .= '>';
-        $Str .= $cache->{$_.':fullname'};
-        $Str .= '</option>'."\n";	     
-    }
+$formname: The name of the form.  If defined the onchange attribute of
+the selection box is set to document.$formname.submit().
 
-    $Str .= '<option';
-    if($selectedName eq 'No Student Selected') {
-        $Str .= ' selected';
-        $selected = 1;
-    }
-    $Str .= '>No Student Selected</option>'."\n";
+$size: the size (number of lines) of the selection box.
 
-    $Str .= '<option';
-    if(!$selected) {
-        $Str .= ' selected';
-    }
-    $Str .= '>All Students</option>'."\n";
-
-    $Str .= '</select>'."\n";
+Returns: a perl string as described.
 
-    return $Str;
-}
+=cut
 
+##############################################
+##############################################
 sub StatusOptions {
-    my ($status, $formName)=@_;
+    my ($status, $formName,$size)=@_;
+    $size = 1 if (!defined($size));
+    if (! defined($status)) {
+        $status = 'Active';
+        $status = $ENV{'form.Status'} if (exists($ENV{'form.Status'}));
+    }
 
     my $OpSel1 = '';
     my $OpSel2 = '';
@@ -467,10 +367,14 @@ sub StatusOptions {
     if(defined($formName) && $formName ne '') {
         $Str .= ' onchange="document.'.$formName.'.submit()"';
     }
+    $Str .= ' size="'.$size.'" ';
     $Str .= '>'."\n";
-    $Str .= '<option'.$OpSel1.'>Active</option>'."\n";
-    $Str .= '<option'.$OpSel2.'>Expired</option>'."\n";
-    $Str .= '<option'.$OpSel3.'>Any</option>'."\n";
+    $Str .= '<option value="Active" '.$OpSel1.'>'.
+        'Currently Enrolled</option>'."\n";
+    $Str .= '<option value="Expired" '.$OpSel2.'>'.
+        'Previously Enrolled</option>'."\n";
+    $Str .= '<option value="Any" '.$OpSel3.'>'.
+        'Any Enrollment Status</option>'."\n";
     $Str .= '</select>'."\n";
 }
 
@@ -674,6 +578,102 @@ sub FormatStudentInformation {
 ########################################################
 ########################################################
 
+=pod
+
+=item Progess Window Handling Routines
+
+These routines handle the creation, update, increment, and closure of 
+progress windows.  The progress window reports to the user the number
+of items completed and an estimate of the time required to complete the rest.
+
+=over 4
+
+
+=item &Create_PrgWin
+
+Writes javascript to the client to open a progress window and returns a
+data structure used for bookkeeping.
+
+Inputs
+
+=over 4
+
+=item $r Apache request
+
+=item $title The title of the progress window
+
+=item $heading A description (usually 1 line) of the process being initiated.
+
+=item $number_to_do The total number of items being processed.
+
+=back
+
+Returns a hash containing the progress state data structure.
+
+
+=item &Update_PrgWin
+
+Updates the text in the progress indicator.  Does not increment the count.
+See &Increment_PrgWin.
+
+Inputs:
+
+=over 4
+
+=item $r Apache request
+
+=item $prog_state Pointer to the data structure returned by &Create_PrgWin
+
+=item $displaystring The string to write to the status indicator
+
+=back
+
+Returns: none
+
+
+=item Increment_PrgWin
+
+Increment the count of items completed for the progress window by 1.  
+
+Inputs:
+
+=over 4
+
+=item $r Apache request
+
+=item $prog_state Pointer to the data structure returned by Create_PrgWin
+
+=item $extraInfo A description of the items being iterated over.  Typically
+'student'.
+
+=back
+
+Returns: none
+
+
+=item Close_PrgWin
+
+Closes the progress window.
+
+Inputs:
+
+=over 4 
+
+=item $r Apache request
+
+=item $prog_state Pointer to the data structure returned by Create_PrgWin
+
+=back
+
+Returns: none
+
+=back
+
+=cut
+
+########################################################
+########################################################
+
 # Create progress
 sub Create_PrgWin {
     my ($r, $title, $heading, $number_to_do)=@_;
@@ -690,8 +690,8 @@ sub Create_PrgWin {
 
     my %prog_state;
     $prog_state{'done'}=0;
-    $prog_state{'firststart'}=time;
-    $prog_state{'laststart'}=time;
+    $prog_state{'firststart'}=&Time::HiRes::time();
+    $prog_state{'laststart'}=&Time::HiRes::time();
     $prog_state{'max'}=$number_to_do;
 
     $r->rflush();
@@ -703,7 +703,7 @@ sub Update_PrgWin {
     my ($r,$prog_state,$displayString)=@_;
     $r->print('<script>popwin.document.popremain.remaining.value="'.
               $displayString.'";</script>');
-    $$prog_state{'laststart'}=time;
+    $$prog_state{'laststart'}=&Time::HiRes::time();
     $r->rflush();
 }
 
@@ -711,7 +711,8 @@ sub Update_PrgWin {
 sub Increment_PrgWin {
     my ($r,$prog_state,$extraInfo)=@_;
     $$prog_state{'done'}++;
-    my $time_est= (time - $$prog_state{'firststart'})/$$prog_state{'done'} *
+    my $time_est= (&Time::HiRes::time() - $$prog_state{'firststart'})/
+        $$prog_state{'done'} *
 	($$prog_state{'max'}-$$prog_state{'done'});
     $time_est = int($time_est);
     if (int ($time_est/60) > 0) {
@@ -726,12 +727,23 @@ sub Increment_PrgWin {
     } else {
 	$time_est .= ' seconds';
     }
-
+    my $lasttime = &Time::HiRes::time()-$$prog_state{'laststart'};
+    if ($lasttime > 9) {
+        $lasttime = int($lasttime);
+    } elsif ($lasttime < 0.01) {
+        $lasttime = 0;
+    } else {
+        $lasttime = sprintf("%3.2f",$lasttime);
+    }
+    if ($lasttime == 1) {
+        $lasttime = '('.$lasttime.' second for '.$extraInfo.')';
+    } else {
+        $lasttime = '('.$lasttime.' seconds for '.$extraInfo.')';
+    }
     $r->print('<script>popwin.document.popremain.remaining.value="'.
 	      $$prog_state{'done'}.'/'.$$prog_state{'max'}.
-	      ': '.$time_est.' remaining ('.(time-$$prog_state{'laststart'}).
-	      ' seconds for '.$extraInfo.')";'.'</script>');
-    $$prog_state{'laststart'}=time;
+	      ': '.$time_est.' remaining '.$lasttime.'";'.'</script>');
+    $$prog_state{'laststart'}=&Time::HiRes::time();
     $r->rflush();
 }
 
@@ -744,4 +756,5 @@ sub Close_PrgWin {
 }
 
 1;
+
 __END__