--- loncom/interface/lonhtmlcommon.pm 2003/01/14 22:01:56 1.11
+++ loncom/interface/lonhtmlcommon.pm 2003/09/03 01:53:46 1.29
@@ -1,7 +1,7 @@
# The LearningOnline Network with CAPA
# a pile of common html routines
#
-# $Id: lonhtmlcommon.pm,v 1.11 2003/01/14 22:01:56 minaeibi Exp $
+# $Id: lonhtmlcommon.pm,v 1.29 2003/09/03 01:53:46 www 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;
}
@@ -128,9 +181,19 @@ sub date_setter {
document.$formname.$dname\_day.value = 30;
}
}
+
+ function $dname\_opencalendar() {
+ var calwin=window.open(
+"/adm/announcements?pickdate=yes&formname=$formname&element=$dname&month="+
+document.$formname.$dname\_month.value+"&year="+
+document.$formname.$dname\_year.value,
+ "LONCAPAcal",
+ "height=350,width=350,scrollbars=yes,resizable=yes,menubar=no");
+
+ }
</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 +206,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 +229,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 .= "<a href=\"javascript:$dname\_opencalendar()\">Select Date</a></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 +306,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 {
@@ -249,174 +317,100 @@ 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";
+$onchange: javascript to use when the value is changed. Enclosed in
+double quotes, ""s, not single quotes.
- return $Str;
-}
+Returns: a perl string as described.
+
+=cut
+##############################################
+##############################################
sub StatusOptions {
- my ($status, $formName)=@_;
+ my ($status, $formName,$size,$onchange)=@_;
+ $size = 1 if (!defined($size));
+ if (! defined($status)) {
+ $status = 'Active';
+ $status = $ENV{'form.Status'} if (exists($ENV{'form.Status'}));
+ }
my $OpSel1 = '';
my $OpSel2 = '';
@@ -428,16 +422,52 @@ sub StatusOptions {
my $Str = '';
$Str .= '<select name="Status"';
- if(defined($formName) && $formName ne '') {
+ if(defined($formName) && $formName ne '' && ! defined($onchange)) {
$Str .= ' onchange="document.'.$formName.'.submit()"';
}
+ if (defined($onchange)) {
+ $Str .= ' onchange="'.$onchange.'"';
+ }
+ $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";
}
+
+########################################################
+########################################################
+
+=pod
+
+=item &MultipleSectionSelect()
+
+Inputs:
+
+=over 4
+
+=item $sections A references to an array containing the names of all the
+sections used in a class.
+
+=item $selectedSections A reference to an array containing the names of the
+currently selected sections.
+
+=back
+
+Returns: a string containing HTML for a multiple select box for
+selecting sections of a course.
+
+The form element name is 'Section'. @$sections is sorted prior to output.
+
+=cut
+
+########################################################
+########################################################
sub MultipleSectionSelect {
my ($sections,$selectedSections)=@_;
@@ -454,10 +484,29 @@ sub MultipleSectionSelect {
$Str .= '>'.$_.'</option>'."\n";
}
$Str .= '</select>'."\n";
-
+
return $Str;
}
+########################################################
+########################################################
+
+=pod
+
+=item &Title()
+
+Inputs: $pageName a string containing the name of the page to be sent
+to &Apache::loncommon::bodytag.
+
+Returns: string containing being <html> and complete <head> and <title>
+as well as a <script> to focus the current window and change its width
+and height to 500. Why? I do not know. If you find out, please update
+this documentation.
+
+=cut
+
+########################################################
+########################################################
sub Title {
my ($pageName)=@_;
@@ -471,9 +520,12 @@ sub Title {
return $Str;
}
+########################################################
+########################################################
+
=pod
-=item &CreateTableHeadings()
+=item &CreateHeadings()
This function generates the column headings for the chart.
@@ -498,6 +550,8 @@ $Str: A formatted string of the table co
=cut
+########################################################
+########################################################
sub CreateHeadings {
my ($data,$keyID,$headings,$displayString,$format)=@_;
my $Str='';
@@ -524,6 +578,9 @@ sub CreateHeadings {
return $Str;
}
+########################################################
+########################################################
+
=pod
=item &FormatStudentInformation()
@@ -553,6 +610,8 @@ $Str: Formatted string.
=cut
+########################################################
+########################################################
sub FormatStudentInformation {
my ($data,$name,$keyID,$displayString,$format)=@_;
my $Str='';
@@ -577,37 +636,198 @@ sub FormatStudentInformation {
return $Str;
}
+########################################################
+########################################################
+
+=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)=@_;
+ my ($r, $title, $heading, $number_to_do)=@_;
$r->print('<script>'.
"popwin=open(\'\',\'popwin\',\'width=400,height=100\');".
- "popwin.document.writeln(\'<html><body bgcolor=\"#88DDFF\">".
- "<title>$title</title>".
+ "popwin.document.writeln(\'<html><head><title>$title</title></head>".
+ "<body bgcolor=\"#88DDFF\">".
"<h4>$heading</h4>".
"<form name=popremain>".
- "<input type=text size=35 name=remaining value=Starting></form>".
+ '<input type="text" size="55" name="remaining" value="Starting"></form>'.
"</body></html>\');".
"popwin.document.close();".
"</script>");
+ my %prog_state;
+ $prog_state{'done'}=0;
+ $prog_state{'firststart'}=&Time::HiRes::time();
+ $prog_state{'laststart'}=&Time::HiRes::time();
+ $prog_state{'max'}=$number_to_do;
+
$r->rflush();
+ return %prog_state;
}
# update progress
sub Update_PrgWin {
- my ($displayString,$r)=@_;
+ my ($r,$prog_state,$displayString)=@_;
$r->print('<script>popwin.document.popremain.remaining.value="'.
$displayString.'";</script>');
+ $$prog_state{'laststart'}=&Time::HiRes::time();
+ $r->rflush();
+}
+
+# increment progress state
+sub Increment_PrgWin {
+ my ($r,$prog_state,$extraInfo)=@_;
+ $$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 ($min < 10) {
+ if ($sec > 1) {
+ $time_est.= ', '.$sec.' seconds';
+ } elsif ($sec > 0) {
+ $time_est.= ', '.$sec.' second';
+ }
+ }
+ } 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.')';
+ }
+ #
+ my $user_browser = $ENV{'browser.type'} if (exists($ENV{'browser.type'}));
+ my $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();
+ }
+ if ($user_browser eq 'explorer' && $user_os =~ 'mac') {
+ $lasttime = '';
+ }
+ $r->print('<script>popwin.document.popremain.remaining.value="'.
+ $$prog_state{'done'}.'/'.$$prog_state{'max'}.
+ ': '.$time_est.' remaining '.$lasttime.'";'.'</script>');
+ $$prog_state{'laststart'}=&Time::HiRes::time();
$r->rflush();
}
# close Progress Line
sub Close_PrgWin {
- my ($r)=@_;
+ my ($r,$prog_state)=@_;
$r->print('<script>popwin.close()</script>'."\n");
+ undef(%$prog_state);
$r->rflush();
}
1;
+
__END__