--- loncom/interface/lonhtmlcommon.pm 2002/07/22 20:35:05 1.1 +++ loncom/interface/lonhtmlcommon.pm 2002/09/17 15:32:46 1.10 @@ -1,17 +1,293 @@ +# The LearningOnline Network with CAPA +# a pile of common html routines +# +# $Id: lonhtmlcommon.pm,v 1.10 2002/09/17 15:32:46 matthew Exp $ +# +# Copyright Michigan State University Board of Trustees +# +# This file is part of the LearningOnline Network with CAPA (LON-CAPA). +# +# LON-CAPA is free software; you can redistribute it and/or modify +# it under the terms of the GNU General Public License as published by +# the Free Software Foundation; either version 2 of the License, or +# (at your option) any later version. +# +# LON-CAPA is distributed in the hope that it will be useful, +# but WITHOUT ANY WARRANTY; without even the implied warranty of +# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +# GNU General Public License for more details. +# +# You should have received a copy of the GNU General Public License +# along with LON-CAPA; if not, write to the Free Software +# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA +# +# /home/httpd/html/adm/gpl.txt +# +# 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\n"; + $result .= < + 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; + } + } + +ENDJS + $result .= " \n"; + $result .= "  "; + $result .= " s\n"; + $result .= "\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)=@_; + + my $OpSel1 = ''; + my $OpSel2 = ''; + + if($order eq 'Ascending') { + $OpSel1 = ' selected'; + } else { + $OpSel2 = ' selected'; + } + + my $Str = ''; + $Str .= ''."\n"; + + return $Str; +} + sub MapOptions { - my ($data, $page)=@_; + my ($data, $page, $formName)=@_; my $Str = ''; $Str .= '{'orderedSequences'})) { + if($data->{$sequence.':title'} eq $map || $map eq 'All Maps') { + foreach my $problem (split(':', $data->{$sequence.':problems'})) { + $Str .= '{$page.'ProblemSelect'} eq + $data->{$problem.':title'}) { + $Str .= ' selected'; + $selected = 1; + } + $Str .= '>'.$data->{$problem.':title'}.''."\n"; + } + } + } + $Str .= ''."\n"; - my $selected=0; + if(!defined($parts)) { + return ''; + } + + $Str .= ''."\n"; return $Str; } -sub CreateStatisticsMainMenu { - my ($status, $reports)=@_; +sub Title { + my ($pageName)=@_; my $Str = ''; - $Str .= ''."\n"; - $Str .= ''."\n"; - $Str .= ''."\n"; - $Str .= ''."\n"; - $Str .= ''."\n"; - $Str .= ''."\n"; - - $Str .= ''."\n"; - - $Str .= '
Analysis Reports:Student Status:
{'reportSelected'} eq $reports->{$_}) { - $Str .= ' selected=""'; - } - $Str .= '>'.$reports->{$_}.''."\n"; - } - $Str .= ''; - $Str .= &StatusOptions($status, 'Statistics'); - $Str .= '
'."\n"; - $Str .= '
'."\n"; + $Str .= ''.$pageName.''."\n"; + $Str .= &Apache::loncommon::bodytag($pageName)."\n"; + $Str .= ''."\n"; return $Str; } @@ -153,11 +479,11 @@ This function generates the column headi =over 4 -Inputs: $CacheData, $studentInformation, $headings, $spacePadding +Inputs: $CacheData, $keyID, $headings, $spacePadding $CacheData: pointer to a hash tied to the cached data database -$studentInformation: a pointer to an array containing the names of the data +$keyID: a pointer to an array containing the names of the data held in a column and is used as part of a key into $CacheData $headings: The names of the headings for the student information @@ -172,19 +498,26 @@ $Str: A formatted string of the table co =cut -sub CreateStudentInformationHeadings { - my ($data,$studentInformation,$headings,$displayString)=@_; +sub CreateHeadings { + my ($data,$keyID,$headings,$displayString,$format)=@_; my $Str=''; + my $formatting = ''; for(my $index=0; $index<(scalar @$headings); $index++) { -# if(!&ShouldShowColumn($data, 'ChartHeading'.$index)) { -# next; -# } - my $data=$headings->[$index]; - my $linkdata=$studentInformation->[$index]; + my $currentHeading=$headings->[$index]; + if($format eq 'preformatted') { + my @dataLength=split(//,$currentHeading); + my $length=scalar @dataLength; + $formatting = (' 'x + ($data->{$keyID->[$index].':columnWidth'}-$length)); + } + my $linkdata=$keyID->[$index]; + my $tempString = $displayString; $tempString =~ s/LINKDATA/$linkdata/; - $tempString =~ s/DISPLAYDATA/$data/; + $tempString =~ s/DISPLAYDATA/$currentHeading/; + $tempString =~ s/FORMATTING/$formatting/; + $Str .= $tempString; } @@ -195,18 +528,18 @@ sub CreateStudentInformationHeadings { =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 -Input: $cache, $name, $studentInformation, $spacePadding +Input: $cache, $name, $keyID, $spacePadding $cache: This is a pointer to a hash that is tied to the cached data $name: The name and domain of the current student in name:domain format -$studentInformation: A pointer to an array holding the names used to +$keyID: A pointer to an array holding the names used to remove data from the hash. They represent the name of the data to be removed. @@ -221,26 +554,60 @@ $Str: Formatted string. =cut sub FormatStudentInformation { - my ($cache,$name,$studentInformation,$spacePadding)=@_; + my ($data,$name,$keyID,$displayString,$format)=@_; my $Str=''; - my $data; + my $currentColumn; + + for(my $index=0; $index<(scalar @$keyID); $index++) { + $currentColumn=$data->{$name.':'.$keyID->[$index]}; + + if($format eq 'preformatted') { + my @dataLength=split(//,$currentColumn); + my $length=scalar @dataLength; + $currentColumn.= (' 'x + ($data->{$keyID->[$index].':columnWidth'}-$length)); + } - for(my $index=0; $index<(scalar @$studentInformation); $index++) { - if(!&ShouldShowColumn($cache, 'ChartHeading'.$index)) { - next; - } - $data=$cache->{$name.':'.$studentInformation->[$index]}; - $Str .= $data; - - my @dataLength=split(//,$data); - my $length=scalar @dataLength; - $Str .= (' 'x($cache->{$studentInformation->[$index].'Length'}- - $length)); - $Str .= $spacePadding; + my $tempString = $displayString; + $tempString =~ s/DISPLAYDATA/$currentColumn/; + + $Str .= $tempString; } return $Str; } +# Create progress +sub Create_PrgWin { + my ($r, $title, $heading)=@_; + $r->print('"); + + $r->rflush(); +} + +# update progress +sub Update_PrgWin { + my ($displayString,$r)=@_; + $r->print(''); + $r->rflush(); +} + +# close Progress Line +sub Close_PrgWin { + my ($r)=@_; + $r->print(''."\n"); + $r->rflush(); +} + 1; __END__