--- loncom/interface/lonhtmlcommon.pm 2002/07/22 20:35:05 1.1 +++ loncom/interface/lonhtmlcommon.pm 2003/05/12 22:04:41 1.21 @@ -1,71 +1,345 @@ +# The LearningOnline Network with CAPA +# a pile of common html routines +# +# $Id: lonhtmlcommon.pm,v 1.21 2003/05/12 22:04:41 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; -sub MapOptions { - my ($data, $page)=@_; - my $Str = ''; - $Str .= '\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 .= " '."\n"; + 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; + } +} - $Str .= ''."\n"; +############################################## +############################################## + +=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 = <Active'."\n"; - $Str .= 'Expired'."\n"; - $Str .= 'Any'."\n"; + $Str .= ''."\n"; + $Str .= ''."\n"; + $Str .= ''."\n"; $Str .= ''."\n"; } -sub Title { - my ($pageName)=@_; - my $Str = ''; +######################################################## +######################################################## - $Str .= ''.$pageName.''."\n"; - $Str .= ''."\n"; - $Str .= ''."\n"; - $Str .= '
'; - $Str .= '

Course: '; - $Str .= $ENV{'course.'.$ENV{'request.course.id'}.'.description'}; - $Str .= '

'."\n"; - $Str .= ''; - $Str .= '
'."\n"; -# $Str .= '

Current Time: '.localtime(time).'




'."\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 .= ''."\n"; + return $Str; } -sub CreateStatisticsMainMenu { - my ($status, $reports)=@_; +######################################################## +######################################################## - my $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 and complete and +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. - $Str .= '<table border="0"><tbody><tr>'."\n"; - $Str .= '<td></td><td></td>'."\n"; - $Str .= '<td align="center"><b>Analysis Reports:</b></td>'."\n"; - $Str .= '<td align="center"><b>Student Status:</b></td></tr>'."\n"; - $Str .= '<tr>'."\n"; - $Str .= '<td align="center"><input type="submit" name="Refresh" '; - $Str .= 'value="Refresh" /></td>'."\n"; - $Str .= '<td align="center"><input type="submit" name="DownloadAll" '; - $Str .= 'value="Update All Student Data" /></td>'."\n"; - $Str .= '<td align="center">'; - $Str .= '<select name="reportSelected" onchange="document.'; - $Str .= 'Statistics.submit()">'."\n"; - - foreach (sort(keys(%$reports))) { - next if($_ eq 'reportSelected'); - $Str .= '<option name="'.$_.'"'; - if($reports->{'reportSelected'} eq $reports->{$_}) { - $Str .= ' selected=""'; - } - $Str .= '>'.$reports->{$_}.'</option>'."\n"; - } - $Str .= '</select></td>'."\n"; - - $Str .= '<td align="center">'; - $Str .= &StatusOptions($status, 'Statistics'); - $Str .= '</td>'."\n"; +=cut - $Str .= '</tr></tbody></table>'."\n"; - $Str .= '<hr>'."\n"; +######################################################## +######################################################## +sub Title { + my ($pageName)=@_; + + my $Str = ''; + + $Str .= '<html><head><title>'.$pageName.''."\n"; + $Str .= &Apache::loncommon::bodytag($pageName)."\n"; + $Str .= ''."\n"; return $Str; } +######################################################## +######################################################## + =pod -=item &CreateTableHeadings() +=item &CreateHeadings() This function generates the column headings for the chart. =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,41 +476,53 @@ $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; } 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 -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. @@ -220,27 +536,107 @@ $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 @$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; + 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)); + } + + my $tempString = $displayString; + $tempString =~ s/DISPLAYDATA/$currentColumn/; + + $Str .= $tempString; } return $Str; } +######################################################## +######################################################## + +# Create progress +sub Create_PrgWin { + my ($r, $title, $heading, $number_to_do)=@_; + $r->print('"); + + my %prog_state; + $prog_state{'done'}=0; + $prog_state{'firststart'}=time; + $prog_state{'laststart'}=time; + $prog_state{'max'}=$number_to_do; + + $r->rflush(); + return %prog_state; +} + +# update progress +sub Update_PrgWin { + my ($r,$prog_state,$displayString)=@_; + $r->print(''); + $$prog_state{'laststart'}=time; + $r->rflush(); +} + +# increment progress state +sub Increment_PrgWin { + my ($r,$prog_state,$extraInfo)=@_; + $$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(''); + $$prog_state{'laststart'}=time; + $r->rflush(); +} + +# close Progress Line +sub Close_PrgWin { + my ($r,$prog_state)=@_; + $r->print(''."\n"); + undef(%$prog_state); + $r->rflush(); +} + 1; __END__