--- loncom/interface/lonhtmlcommon.pm 2002/08/21 17:18:08 1.8
+++ loncom/interface/lonhtmlcommon.pm 2003/02/20 14:34:59 1.13
@@ -1,7 +1,7 @@
# The LearningOnline Network with CAPA
# a pile of common html routines
#
-# $Id: lonhtmlcommon.pm,v 1.8 2002/08/21 17:18:08 www Exp $
+# $Id: lonhtmlcommon.pm,v 1.13 2003/02/20 14:34:59 matthew Exp $
#
# Copyright Michigan State University Board of Trustees
#
@@ -25,11 +25,230 @@
#
# http://www.lon-capa.org/
#
+######################################################################
+######################################################################
+
+=pod
+
+=head1 NAME
+
+Apache::lonhtmlcommon - routines to do common html things
+
+=head1 SYNOPSIS
+
+Referenced by other mod_perl Apache modules.
+
+=head1 INTRODUCTION
+
+lonhtmlcommon is a collection of subroutines used to present information
+in a consistent html format, or provide other functionality related to
+html.
+
+=head2 General Subroutines
+
+=over 4
+
+=cut
+
+######################################################################
+######################################################################
package Apache::lonhtmlcommon;
+use Time::Local;
use strict;
+##############################################
+##############################################
+
+=pod
+
+=item &date_setter
+
+Inputs
+
+=over 4
+
+=item $dname
+
+The name to prepend to the form elements.
+The form elements defined will be dname_year, dname_month, dname_day,
+dname_hour, dname_min, and dname_sec.
+
+=item $currentvalue
+
+The current setting for this time parameter. A unix format time
+(time in seconds since the beginning of Jan 1st, 1970, GMT.
+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.
+
+=cut
+
+##############################################
+##############################################
+sub date_setter {
+ my ($formname,$dname,$currentvalue) = @_;
+ if (! defined($currentvalue) || $currentvalue eq 'now') {
+ $currentvalue = time;
+ }
+ # other potentially useful values: wkday,yrday,is_daylight_savings
+ my ($sec,$min,$hour,$mday,$month,$year,undef,undef,undef) =
+ localtime($currentvalue);
+ $year += 1900;
+ my $result = "\n<!-- $dname date setting form -->\n";
+ $result .= <<ENDJS;
+<script language="Javascript">
+ function $dname\_checkday() {
+ var day = document.$formname.$dname\_day.value;
+ var month = document.$formname.$dname\_month.value;
+ var year = document.$formname.$dname\_year.value;
+ var valid = true;
+ if (day < 1) {
+ document.$formname.$dname\_day.value = 1;
+ }
+ if (day > 31) {
+ document.$formname.$dname\_day.value = 31;
+ }
+ if ((month == 1) || (month == 3) || (month == 5) ||
+ (month == 7) || (month == 8) || (month == 10) ||
+ (month == 12)) {
+ if (day > 31) {
+ document.$formname.$dname\_day.value = 31;
+ day = 31;
+ }
+ } else if (month == 2 ) {
+ if ((year % 4 == 0) && (year % 100 != 0)) {
+ if (day > 29) {
+ document.$formname.$dname\_day.value = 29;
+ }
+ } else if (day > 29) {
+ document.$formname.$dname\_day.value = 28;
+ }
+ } else if (day > 30) {
+ document.$formname.$dname\_day.value = 30;
+ }
+ }
+</script>
+ENDJS
+ $result .= " <select name=\"$dname\_month\" ".
+ "onChange=\"javascript:$dname\_checkday()\" >\n";
+ my @Months = qw/January February March April May June
+ July August September October November December/;
+ # Pad @Months with a bogus value to make indexing easier
+ unshift(@Months,'If you can read this an error occurred');
+ for(my $m = 1;$m <=$#Months;$m++) {
+ $result .= " <option value=\"$m\" ";
+ $result .= "selected " if ($m-1 == $month);
+ $result .= "> $Months[$m] </option>\n";
+ }
+ $result .= " </select>\n";
+ $result .= " <input type=\"text\" name=\"$dname\_day\" ".
+ "value=\"$mday\" size=\"3\" ".
+ "onChange=\"javascript:$dname\_checkday()\" />\n";
+ $result .= " <input type=\"year\" name=\"$dname\_year\" ".
+ "value=\"$year\" size=\"5\" ".
+ "onChange=\"javascript:$dname\_checkday()\" />\n";
+ $result .= " ";
+ $result .= " <select name=\"$dname\_hour\" >\n";
+ for (my $h = 0;$h<24;$h++) {
+ $result .= " <option value=\"$h\" ";
+ $result .= "selected " if ($hour == $h);
+ $result .= "> ";
+ if ($h == 0) {
+ $result .= "12 am";
+ } elsif($h == 12) {
+ $result .= "12 noon";
+ } elsif($h < 12) {
+ $result .= "$h am";
+ } else {
+ $result .= $h-12 ." pm";
+ }
+ $result .= " </option>\n";
+ }
+ $result .= " </select>\n";
+ $result .= " <input type=\"text\" name=\"$dname\_minute\" ".
+ "value=\"$min\" size=\"3\" /> m\n";
+ $result .= " <input type=\"text\" name=\"$dname\_second\" ".
+ "value=\"$sec\" size=\"3\" /> s\n";
+ $result .= "<!-- end $dname date setting form -->\n";
+ return $result;
+}
+
+##############################################
+##############################################
+
+=item &get_date_from_form
+
+Inputs:
+
+=over 4
+
+=item $dname
+
+The name passed to &datesetter, which prefixes the form elements.
+
+=item $defaulttime
+
+The unix time to use as the default in case of poor inputs.
+
+=back
+
+Returns: Unix time represented in the form.
+
+=cut
+
+##############################################
+##############################################
+sub get_date_from_form {
+ my ($dname) = @_;
+ my ($sec,$min,$hour,$day,$month,$year);
+ #
+ if (defined($ENV{'form.'.$dname.'_second'})) {
+ my $tmpsec = $ENV{'form.'.$dname.'_second'};
+ if (($tmpsec =~ /^\d+$/) && ($tmpsec >= 0) && ($tmpsec < 60)) {
+ $sec = $tmpsec;
+ }
+ }
+ if (defined($ENV{'form.'.$dname.'_minute'})) {
+ my $tmpmin = $ENV{'form.'.$dname.'_minute'};
+ if (($tmpmin =~ /^\d+$/) && ($tmpmin >= 0) && ($tmpmin < 60)) {
+ $min = $tmpmin;
+ }
+ }
+ if (defined($ENV{'form.'.$dname.'_hour'})) {
+ my $tmphour = $ENV{'form.'.$dname.'_hour'};
+ if (($tmphour =~ /^\d+$/) && ($tmphour > 0) && ($tmphour < 32)) {
+ $hour = $tmphour;
+ }
+ }
+ if (defined($ENV{'form.'.$dname.'_day'})) {
+ my $tmpday = $ENV{'form.'.$dname.'_day'};
+ if (($tmpday =~ /^\d+$/) && ($tmpday > 0) && ($tmpday < 32)) {
+ $day = $tmpday;
+ }
+ }
+ if (defined($ENV{'form.'.$dname.'_month'})) {
+ my $tmpmonth = $ENV{'form.'.$dname.'_month'};
+ if (($tmpmonth =~ /^\d+$/) && ($tmpmonth > 0) && ($tmpmonth < 13)) {
+ $month = $tmpmonth - 1;
+ }
+ }
+ if (defined($ENV{'form.'.$dname.'_year'})) {
+ my $tmpyear = $ENV{'form.'.$dname.'_year'};
+ if (($tmpyear =~ /^\d+$/) && ($tmpyear > 1900)) {
+ $year = $tmpyear - 1900;
+ }
+ }
+ if (eval(&timelocal($sec,$min,$hour,$day,$month,$year))) {
+ return &timelocal($sec,$min,$hour,$day,$month,$year);
+ } else {
+ return undef;
+ }
+}
+
+##############################################
+##############################################
+
sub AscendOrderOptions {
my ($order, $page, $formName)=@_;
@@ -85,6 +304,76 @@ sub MapOptions {
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)=@_;
@@ -149,13 +438,42 @@ sub StatusOptions {
$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)=@_;
my $Str = '';
$Str .= '<select name="Section" multiple="true" size="4">'."\n";
- foreach (@$sections) {
+ foreach (sort @$sections) {
$Str .= '<option';
foreach my $selected (@$selectedSections) {
if($_ eq $selected) {
@@ -165,10 +483,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)=@_;
@@ -182,9 +519,12 @@ sub Title {
return $Str;
}
+########################################################
+########################################################
+
=pod
-=item &CreateTableHeadings()
+=item &CreateHeadings()
This function generates the column headings for the chart.
@@ -209,6 +549,8 @@ $Str: A formatted string of the table co
=cut
+########################################################
+########################################################
sub CreateHeadings {
my ($data,$keyID,$headings,$displayString,$format)=@_;
my $Str='';
@@ -235,11 +577,14 @@ sub CreateHeadings {
return $Str;
}
+########################################################
+########################################################
+
=pod
=item &FormatStudentInformation()
-This function produces a formatted string of the student's information:
+This function produces a formatted string of the student\'s information:
username, domain, section, full name, and PID.
=over 4
@@ -264,6 +609,8 @@ $Str: Formatted string.
=cut
+########################################################
+########################################################
sub FormatStudentInformation {
my ($data,$name,$keyID,$displayString,$format)=@_;
my $Str='';
@@ -288,6 +635,9 @@ sub FormatStudentInformation {
return $Str;
}
+########################################################
+########################################################
+
# Create progress
sub Create_PrgWin {
my ($r, $title, $heading)=@_;