--- loncom/interface/lonhtmlcommon.pm 2003/03/03 22:00:03 1.15
+++ loncom/interface/lonhtmlcommon.pm 2003/05/21 16:16:32 1.22
@@ -1,7 +1,7 @@
# The LearningOnline Network with CAPA
# a pile of common html routines
#
-# $Id: lonhtmlcommon.pm,v 1.15 2003/03/03 22:00:03 albertel Exp $
+# $Id: lonhtmlcommon.pm,v 1.22 2003/05/21 16:16:32 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
@@ -249,174 +262,97 @@ sub get_date_from_form {
##############################################
##############################################
-sub AscendOrderOptions {
- my ($order, $page, $formName)=@_;
-
- my $OpSel1 = '';
- my $OpSel2 = '';
-
- if($order eq 'Ascending') {
- $OpSel1 = ' selected';
- } else {
- $OpSel2 = ' selected';
- }
+=pod
- 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";
+=item &pjump_javascript_definition()
- return $Str;
-}
+Returns javascript defining the 'pjump' function, which opens up a
+parameter setting wizard.
-sub MapOptions {
- my ($data, $page, $formName)=@_;
- my $Str = '';
- $Str .= '<select name="';
- $Str .= (($page)?$page:'').'Maps"';
- if($formName) {
- $Str .= ' onchange="document.'.$formName.'.submit()"';
- }
- $Str .= '>'."\n";
+=cut
- 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';
+##############################################
+##############################################
+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");
}
- $Str .= '>All Maps</option>'."\n";
-
- $Str .= '</select>'."\n";
-
+END
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";
+=pod
- $Str .= '</select>'."\n";
+=item &javascript_nothing()
- return $Str;
-}
+Return an appropriate null for the users browser. This is used
+as the first arguement for window.open calls when you want a blank
+window that you can then write to.
-sub PartOptions {
- my ($data, $page, $parts, $formName)=@_;
- my $Str = '';
+=cut
- if(!defined($parts)) {
- return '';
+##############################################
+##############################################
+sub javascript_nothing {
+ # mozilla and other browsers work with "''", but IE on mac does not.
+ my $nothing = "''";
+ my $user_browser;
+ my $user_os;
+ $user_browser = $ENV{'browser.type'} if (exists($ENV{'browser.type'}));
+ $user_os = $ENV{'browser.os'} if (exists($ENV{'browser.os'}));
+ if (! defined($user_browser) || ! defined($user_os)) {
+ (undef,$user_browser,undef,undef,undef,$user_os) =
+ &Apache::loncommon::decode_user_agent();
}
-
- $Str .= '<select name="';
- $Str .= (($page)?$page:'').'PartSelect"';
- if($formName) {
- $Str .= ' onchange="document.'.$formName.'.submit()"';
+ if ($user_browser eq 'explorer' && $user_os =~ 'mac') {
+ $nothing = "'javascript:void(0);'";
}
- $Str .= '>'."\n";
+ return $nothing;
+}
- 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;
-}
+=pod
-sub StudentOptions {
- my ($cache, $students, $selectedName, $page, $formName)=@_;
+=item &StatusOptions()
- my $Str = '';
- $Str .= '<select name="'.(($page)?$page:'').'Student"';
- if($formName) {
- $Str .= ' onchange="document.'.$formName.'.submit()"';
- }
- $Str .= '>'."\n";
+Returns html for a selection box which allows the user to choose the
+enrollment status of students. The selection box name is 'Status'.
- 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 = '';
@@ -431,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";
}
@@ -653,10 +593,10 @@ sub Create_PrgWin {
"</script>");
my %prog_state;
- $prog_state{'now'}=0;
- $prog_state{'since'}=time;
- $prog_state{'started'}=time;
- $prog_state{'total'}=$number_to_do;
+ $prog_state{'done'}=0;
+ $prog_state{'firststart'}=time;
+ $prog_state{'laststart'}=time;
+ $prog_state{'max'}=$number_to_do;
$r->rflush();
return %prog_state;
@@ -667,21 +607,39 @@ sub Update_PrgWin {
my ($r,$prog_state,$displayString)=@_;
$r->print('<script>popwin.document.popremain.remaining.value="'.
$displayString.'";</script>');
- $$prog_state{'started'}=time;
+ $$prog_state{'laststart'}=time;
$r->rflush();
}
# increment progress state
sub Increment_PrgWin {
my ($r,$prog_state,$extraInfo)=@_;
- $$prog_state{'now'}++;
+ $$prog_state{'done'}++;
+ my $time_est= (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';
+ }
+ } else {
+ $time_est .= ' seconds';
+ }
+ my $lasttime = time-$$prog_state{'laststart'};
+ if ($lasttime == 1) {
+ $lasttime = '('.$lasttime.' second for '.$extraInfo.')';
+ } else {
+ $lasttime = '('.$lasttime.' seconds for '.$extraInfo.')';
+ }
$r->print('<script>popwin.document.popremain.remaining.value="'.
- $$prog_state{'now'}.'/'.$$prog_state{'total'}.
- ': '.int((time-$$prog_state{'since'})/
- $$prog_state{'now'}*($$prog_state{'total'}-$$prog_state{'now'})).
- ' secs remaining ('.(time-$$prog_state{'started'}).
- ' seconds for '.$extraInfo.')";'.'</script>');
- $$prog_state{'started'}=time;
+ $$prog_state{'done'}.'/'.$$prog_state{'max'}.
+ ': '.$time_est.' remaining '.$lasttime.'";'.'</script>');
+ $$prog_state{'laststart'}=time;
$r->rflush();
}