--- loncom/interface/lonhtmlcommon.pm 2004/01/26 19:55:44 1.41
+++ loncom/interface/lonhtmlcommon.pm 2004/02/18 08:07:16 1.52
@@ -1,7 +1,7 @@
# The LearningOnline Network with CAPA
# a pile of common html routines
#
-# $Id: lonhtmlcommon.pm,v 1.41 2004/01/26 19:55:44 www Exp $
+# $Id: lonhtmlcommon.pm,v 1.52 2004/02/18 08:07:16 www Exp $
#
# Copyright Michigan State University Board of Trustees
#
@@ -56,6 +56,7 @@ html.
package Apache::lonhtmlcommon;
use Time::Local;
+use Time::HiRes;
use Apache::lonlocal;
use strict;
@@ -169,8 +170,6 @@ sub checkbox {
return $Str;
}
-
-
##############################################
##############################################
@@ -527,203 +526,6 @@ 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 (sort @$sections) {
- $Str .= '<option';
- foreach my $selected (@$selectedSections) {
- if($_ eq $selected) {
- $Str .= ' selected=""';
- }
- }
- $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)=@_;
-
- my $Str = '';
-
- $Str .= '<html><head><title>'.$pageName.'</title></head>'."\n";
- $Str .= &Apache::loncommon::bodytag($pageName)."\n";
- $Str .= '<script>window.focus(); window.width=500;window.height=500;';
- $Str .= '</script>'."\n";
-
- return $Str;
-}
-
-########################################################
-########################################################
-
-=pod
-
-=item &CreateHeadings()
-
-This function generates the column headings for the chart.
-
-=over 4
-
-Inputs: $CacheData, $keyID, $headings, $spacePadding
-
-$CacheData: pointer to a hash tied to the cached data database
-
-$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
-
-$spacePadding: The spaces to go between columns
-
-Output: $Str
-
-$Str: A formatted string of the table column headings.
-
-=back
-
-=cut
-
-########################################################
-########################################################
-sub CreateHeadings {
- my ($data,$keyID,$headings,$displayString,$format)=@_;
- my $Str='';
- my $formatting = '';
-
- for(my $index=0; $index<(scalar @$headings); $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/$currentHeading/;
- $tempString =~ s/FORMATTING/$formatting/;
-
- $Str .= $tempString;
- }
-
- return $Str;
-}
-
-########################################################
-########################################################
-
-=pod
-
-=item &FormatStudentInformation()
-
-This function produces a formatted string of the student\'s information:
-username, domain, section, full name, and PID.
-
-=over 4
-
-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
-
-$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.
-
-$spacePadding: Extra spaces that represent the space between columns
-
-Output: $Str
-
-$Str: Formatted string.
-
-=back
-
-=cut
-
-########################################################
-########################################################
-sub FormatStudentInformation {
- my ($data,$name,$keyID,$displayString,$format)=@_;
- my $Str='';
- 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));
- }
-
- my $tempString = $displayString;
- $tempString =~ s/DISPLAYDATA/$currentColumn/;
-
- $Str .= $tempString;
- }
-
- return $Str;
-}
-
########################################################
########################################################
@@ -755,6 +557,15 @@ Inputs
=item $number_to_do The total number of items being processed.
+=item $type Either 'popup' or 'inline' (popup is assumed if nothing is
+ specified)
+
+=item $width Specify the width in charaters of the input field.
+
+=item $formname Only useful in the inline case, if a form already exists, this needs to be used and specfiy the name of the form, otherwise the Progress line will be created in a new form of it's own
+
+=item $inputname Only useful in the inline case, if a form and an input of type text exists, use this to specify the name of the input field
+
=back
Returns a hash containing the progress state data structure.
@@ -823,38 +634,75 @@ Returns: none
########################################################
########################################################
+my $uniq=0;
+sub get_uniq_name {
+ $uniq++;
+ return 'uniquename'.$uniq;
+}
+
# Create progress
sub Create_PrgWin {
- my ($r, $title, $heading, $number_to_do)=@_;
- $r->print('<script>'.
- "popwin=open(\'\',\'popwin\',\'width=400,height=100\');".
- "popwin.document.writeln(\'<html><head><title>$title</title></head>".
+ my ($r, $title, $heading, $number_to_do,$type,$width,$formname,
+ $inputname)=@_;
+ if (!defined($type)) { $type='popup'; }
+ if (!defined($width)) { $width=55; }
+ my %prog_state;
+ $prog_state{'type'}=$type;
+ if ($type eq 'popup') {
+ $prog_state{'window'}='popwin';
+ #the whole function called through timeout is due to issues
+ #in mozilla Read BUG #2665 if you want to know the whole story
+ &r_print($r,'<script>'.
+ "var popwin;
+ function openpopwin () {
+ popwin=open(\'\',\'popwin\',\'width=400,height=100\');".
+ "popwin.document.writeln(\'<html><head><title>$title</title></head>".
"<body bgcolor=\"#88DDFF\">".
"<h4>$heading</h4>".
"<form name=popremain>".
- '<input type="text" size="55" name="remaining" value="'.
+ '<input type="text" size="'.$width.'" name="remaining" value="'.
&mt('Starting').'"></form>'.
"</body></html>\');".
- "popwin.document.close();".
- "</script>");
+ "popwin.document.close();}".
+ "\nwindow.setTimeout(openpopwin,0)</script>");
+ $prog_state{'formname'}='popremain';
+ $prog_state{'inputname'}="remaining";
+ } elsif ($type eq 'inline') {
+ $prog_state{'window'}='window';
+ if (!$formname) {
+ $prog_state{'formname'}=&get_uniq_name();
+ &r_print($r,'<form name="'.$prog_state{'formname'}.'">');
+ } else {
+ $prog_state{'formname'}=$formname;
+ }
+ if (!$inputname) {
+ $prog_state{'inputname'}=&get_uniq_name();
+ &r_print($r,'<input type="text" name="'.$prog_state{'inputname'}.
+ '" size="'.$width.'" />');
+ } else {
+ $prog_state{'inputname'}=$inputname;
+
+ }
+ if (!$formname) { &r_print($r,'</form>'); }
+ &Update_PrgWin($r,\%prog_state,&mt('Starting'));
+ }
- 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 ($r,$prog_state,$displayString)=@_;
- $r->print('<script>popwin.document.popremain.remaining.value="'.
- $displayString.'";</script>');
+ &r_print($r,'<script>'.$$prog_state{'window'}.'.document.'.
+ $$prog_state{'formname'}.'.'.
+ $$prog_state{'inputname'}.'.value="'.
+ $displayString.'";</script>');
$$prog_state{'laststart'}=&Time::HiRes::time();
- $r->rflush();
}
# increment progress state
@@ -902,21 +750,34 @@ sub Increment_PrgWin {
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.' '.&mt('remaining').' '.$lasttime.'";'.'</script>');
+ &r_print($r,'<script>'.$$prog_state{'window'}.'.document.'.
+ $$prog_state{'formname'}.'.'.
+ $$prog_state{'inputname'}.'.value="'.
+ $$prog_state{'done'}.'/'.$$prog_state{'max'}.
+ ': '.$time_est.' '.&mt('remaining').' '.$lasttime.'";'.'</script>');
$$prog_state{'laststart'}=&Time::HiRes::time();
- $r->rflush();
}
# close Progress Line
sub Close_PrgWin {
my ($r,$prog_state)=@_;
- $r->print('<script>popwin.close()</script>'."\n");
+ if ($$prog_state{'type'} eq 'popup') {
+ &r_print($r,'<script>popwin.close()</script>'."\n");
+ } elsif ($$prog_state{'type'} eq 'inline') {
+ &Update_PrgWin($r,$prog_state,&mt('Done'));
+ }
undef(%$prog_state);
- $r->rflush();
}
+sub r_print {
+ my ($r,$to_print)=@_;
+ if ($r) {
+ $r->print($to_print);
+ $r->rflush();
+ } else {
+ print($to_print);
+ }
+}
# ------------------------------------------------------- Puts directory header
@@ -924,10 +785,11 @@ sub crumbs {
my ($uri,$target,$prefix,$form)=@_;
my $output='<br /><tt><b><font size="+2">'.$prefix.'/';
if ($ENV{'user.adv'}) {
- my $path=$prefix;
+ my $path=$prefix.'/';
foreach (split('/',$uri)) {
unless ($_) { next; }
- $path.='/'.$_;
+ $path.=$_;
+ unless ($path eq $uri) { $path.='/'; }
my $linkpath=$path;
if ($form) {
$linkpath="javascript:$form.action='$path';$form.submit();";
@@ -941,6 +803,37 @@ sub crumbs {
return $output.'</font></b></tt><br />';
}
+# ------------------------------------------------- Output headers for HTMLArea
+
+sub htmlareaheaders {
+ unless (&htmlareabrowser()) { return ''; }
+ my $lang='en';
+ return (<<ENDHEADERS);
+<script type="text/javascript" src="/htmlarea/htmlarea.js"></script>
+<script type="text/javascript" src="/htmlarea/lang/$lang.js"></script>
+<script type="text/javascript" src="/htmlarea/dialog.js"></script>
+<style type="text/css">
+\@import url(/htmlarea/htmlarea.css);
+</style>
+ENDHEADERS
+}
+
+# ---------------------------------------------------------- Script to activate
+
+sub htmlareaactive {
+ unless (&htmlareabrowser()) { return ''; }
+ return (<<ENDSCRIPT);
+<script type="text/javascript" defer="1">
+ HTMLArea.replaceAll();
+</script>
+ENDSCRIPT
+}
+
+# ---------------------------------------- Browser capable of running HTMLArea?
+
+sub htmlareabrowser {
+ return 1;
+}
1;