--- loncom/interface/lonhtmlcommon.pm 2003/03/21 15:59:14 1.19
+++ loncom/interface/lonhtmlcommon.pm 2003/06/20 16:13:06 1.26
@@ -1,7 +1,7 @@
# The LearningOnline Network with CAPA
# a pile of common html routines
#
-# $Id: lonhtmlcommon.pm,v 1.19 2003/03/21 15:59:14 matthew Exp $
+# $Id: lonhtmlcommon.pm,v 1.26 2003/06/20 16:13:06 matthew Exp $
#
# Copyright Michigan State University Board of Trustees
#
@@ -58,6 +58,45 @@ package Apache::lonhtmlcommon;
use Time::Local;
use strict;
+
+##############################################
+##############################################
+
+=pod
+
+=item textbox
+
+=cut
+
+##############################################
+##############################################
+sub textbox {
+ my ($name,$value,$size,$special) = @_;
+ $size = 40 if (! defined($size));
+ my $Str = '<input type="text" name="'.$name.'" size="'.$size.'" '.
+ 'value="'.$value.'" '.$special.' />';
+ return $Str;
+}
+
+##############################################
+##############################################
+
+=pod
+
+=item checkbox
+
+=cut
+
+##############################################
+##############################################
+sub checkbox {
+ my ($name) = @_;
+ my $Str = '<input type="checkbox" name="'.$name.'" />';
+ return $Str;
+}
+
+
+
##############################################
##############################################
@@ -65,6 +104,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,12 +124,23 @@ 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.
+=item $special
+
+Additional html/javascript to be associated with each element in
+the date_setter. See lonparmset for example usage.
+
+=back
+
+Bugs
+
+The method used to restrict user input will fail in the year 2400.
+
=cut
##############################################
##############################################
sub date_setter {
- my ($formname,$dname,$currentvalue) = @_;
+ my ($formname,$dname,$currentvalue,$special) = @_;
if (! defined($currentvalue) || $currentvalue eq 'now') {
$currentvalue = time;
}
@@ -130,7 +183,7 @@ sub date_setter {
}
</script>
ENDJS
- $result .= " <select name=\"$dname\_month\" ".
+ $result .= " <nobr><select name=\"$dname\_month\" ".$special.' '.
"onChange=\"javascript:$dname\_checkday()\" >\n";
my @Months = qw/January February March April May June
July August September October November December/;
@@ -143,13 +196,13 @@ ENDJS
}
$result .= " </select>\n";
$result .= " <input type=\"text\" name=\"$dname\_day\" ".
- "value=\"$mday\" size=\"3\" ".
+ "value=\"$mday\" size=\"3\" ".$special.' '.
"onChange=\"javascript:$dname\_checkday()\" />\n";
$result .= " <input type=\"year\" name=\"$dname\_year\" ".
- "value=\"$year\" size=\"5\" ".
+ "value=\"$year\" size=\"5\" ".$special.' '.
"onChange=\"javascript:$dname\_checkday()\" />\n";
$result .= " ";
- $result .= " <select name=\"$dname\_hour\" >\n";
+ $result .= " <select name=\"$dname\_hour\" ".$special." >\n";
for (my $h = 0;$h<24;$h++) {
$result .= " <option value=\"$h\" ";
$result .= "selected " if ($hour == $h);
@@ -166,19 +219,23 @@ ENDJS
$result .= " </option>\n";
}
$result .= " </select>\n";
- $result .= " <input type=\"text\" name=\"$dname\_minute\" ".
+ $result .= " <input type=\"text\" name=\"$dname\_minute\" ".$special.' '.
"value=\"$min\" size=\"3\" /> m\n";
- $result .= " <input type=\"text\" name=\"$dname\_second\" ".
+ $result .= " <input type=\"text\" name=\"$dname\_second\" ".$special.' '.
"value=\"$sec\" size=\"3\" /> s\n";
- $result .= "<!-- end $dname date setting form -->\n";
+ $result .= "</nobr>\n<!-- end $dname date setting form -->\n";
return $result;
}
##############################################
##############################################
+=pod
+
=item &get_date_from_form
+get_date_from_form retrieves the date specified in an &date_setter form.
+
Inputs:
=over 4
@@ -239,6 +296,7 @@ sub get_date_from_form {
$year = $tmpyear - 1900;
}
}
+ if (($year<70) || ($year>137)) { return undef; }
if (eval(&timelocal($sec,$min,$hour,$day,$month,$year))) {
return &timelocal($sec,$min,$hour,$day,$month,$year);
} else {
@@ -251,6 +309,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
@@ -278,179 +363,41 @@ sub javascript_nothing {
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";
-
- my $selected=0;
+Inputs:
- foreach (@$students) {
- $Str .= '<option';
- if($selectedName eq $_) {
- $Str .= ' selected';
- $selected = 1;
- }
- $Str .= '>';
- $Str .= $cache->{$_.':fullname'};
- $Str .= '</option>'."\n";
- }
+$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.
- $Str .= '<option';
- if($selectedName eq 'No Student Selected') {
- $Str .= ' selected';
- $selected = 1;
- }
- $Str .= '>No Student Selected</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(!$selected) {
- $Str .= ' selected';
- }
- $Str .= '>All Students</option>'."\n";
+$size: the size (number of lines) of the selection box.
- $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 = '';
@@ -465,10 +412,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";
}
@@ -672,6 +623,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)=@_;
@@ -688,8 +735,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();
@@ -701,7 +748,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();
}
@@ -709,22 +756,32 @@ 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) {
my $min = int($time_est/60);
my $sec = $time_est % 60;
$time_est = $min.' minutes';
- if ($sec > 1) {
- $time_est.= ', '.$sec.' seconds';
- } elsif ($sec > 0) {
- $time_est.= ', '.$sec.' second';
- }
+ if ($min < 10) {
+ if ($sec > 1) {
+ $time_est.= ', '.$sec.' seconds';
+ } elsif ($sec > 0) {
+ $time_est.= ', '.$sec.' second';
+ }
+ }
} else {
$time_est .= ' seconds';
}
- my $lasttime = time-$$prog_state{'laststart'};
+ 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 {
@@ -733,7 +790,7 @@ sub Increment_PrgWin {
$r->print('<script>popwin.document.popremain.remaining.value="'.
$$prog_state{'done'}.'/'.$$prog_state{'max'}.
': '.$time_est.' remaining '.$lasttime.'";'.'</script>');
- $$prog_state{'laststart'}=time;
+ $$prog_state{'laststart'}=&Time::HiRes::time();
$r->rflush();
}
@@ -746,4 +803,5 @@ sub Close_PrgWin {
}
1;
+
__END__