--- loncom/interface/lonhtmlcommon.pm 2003/09/03 01:53:46 1.29 +++ 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.29 2003/09/03 01:53:46 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,8 @@ html. package Apache::lonhtmlcommon; use Time::Local; +use Time::HiRes; +use Apache::lonlocal; use strict; @@ -64,6 +66,78 @@ use strict; =pod +=item authorbombs + +=cut + +############################################## +############################################## + +sub authorbombs { + my $url=shift; + $url=&Apache::lonnet::declutter($url); + my ($udom,$uname)=($url=~/^(\w+)\/(\w+)\//); + my %bombs=&Apache::lonmsg::all_url_author_res_msg($uname,$udom); + foreach (keys %bombs) { + if ($_=~/^$udom\/$uname\//) { + return '<a href="/adm/bombs/'.$url. + '"><img src="/adm/lonMisc/bomb.gif" border="0" /></a>'. + &Apache::loncommon::help_open_topic('About_Bombs'); + } + } + return ''; +} + +############################################## +############################################## + +sub recent_filename { + my $area=shift; + return 'nohist_recent_'.&Apache::lonnet::escape($area); +} + +sub store_recent { + my ($area,$name,$value)=@_; + my $file=&recent_filename($area); + my %recent=&Apache::lonnet::dump($file); + if (scalar(keys(%recent))>10) { +# remove oldest value + my $oldest=time; + my $delkey=''; + foreach (keys %recent) { + my $thistime=(split(/\&/,$recent{$_}))[0]; + if ($thistime<$oldest) { + $oldest=$thistime; + $delkey=$_; + } + } + &Apache::lonnet::del($file,[$delkey]); + } +# store new value + &Apache::lonnet::put($file,{ $name => + time.'&'.&Apache::lonnet::escape($value) }); +} + +sub select_recent { + my ($area,$fieldname,$event)=@_; + my %recent=&Apache::lonnet::dump(&recent_filename($area)); + my $return="\n<select name='$fieldname'". + ($event?" onChange='$event'":''). + ">\n<option value=''>--- ".&mt('Recent')." ---</option>"; + foreach (sort keys %recent) { + unless ($_=~/^error\:/) { + $return.="\n<option value='$_'>". + &Apache::lonnet::unescape((split(/\&/,$recent{$_}))[1]). + '</option>'; + } + } + $return.="\n</select>\n"; + return $return; +} + + +=pod + =item textbox =cut @@ -90,13 +164,12 @@ sub textbox { ############################################## ############################################## sub checkbox { - my ($name) = @_; - my $Str = '<input type="checkbox" name="'.$name.'" />'; + my ($name,$value) = @_; + my $Str = '<input type="checkbox" name="'.$name.'"'. + ($value?' checked="1"':'').' />'; return $Str; } - - ############################################## ############################################## @@ -140,14 +213,21 @@ The method used to restrict user input w ############################################## ############################################## sub date_setter { - my ($formname,$dname,$currentvalue,$special) = @_; + my ($formname,$dname,$currentvalue,$special,$includeempty) = @_; if (! defined($currentvalue) || $currentvalue eq 'now') { - $currentvalue = time; + unless ($includeempty) { + $currentvalue = time; + } else { + $currentvalue = 0; + } } # other potentially useful values: wkday,yrday,is_daylight_savings - my ($sec,$min,$hour,$mday,$month,$year,undef,undef,undef) = - localtime($currentvalue); - $year += 1900; + my ($sec,$min,$hour,$mday,$month,$year)=('','','','','',''); + if ($currentvalue) { + ($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"> @@ -199,10 +279,11 @@ ENDJS 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'); + if ($includeempty) { $result.="<option value=''></option>"; } for(my $m = 1;$m <=$#Months;$m++) { $result .= " <option value=\"$m\" "; - $result .= "selected " if ($m-1 == $month); - $result .= "> $Months[$m] </option>\n"; + $result .= "selected " if ($m-1 eq $month); + $result .= "> ".&mt($Months[$m])." </option>\n"; } $result .= " </select>\n"; $result .= " <input type=\"text\" name=\"$dname\_day\" ". @@ -213,27 +294,31 @@ ENDJS "onChange=\"javascript:$dname\_checkday()\" />\n"; $result .= " "; $result .= " <select name=\"$dname\_hour\" ".$special." >\n"; + if ($includeempty) { $result.="<option value=''></option>"; } for (my $h = 0;$h<24;$h++) { $result .= " <option value=\"$h\" "; $result .= "selected " if ($hour == $h); $result .= "> "; + my $timest=''; if ($h == 0) { - $result .= "12 am"; + $timest .= "12 am"; } elsif($h == 12) { - $result .= "12 noon"; + $timest .= "12 noon"; } elsif($h < 12) { - $result .= "$h am"; + $timest .= "$h am"; } else { - $result .= $h-12 ." pm"; + $timest .= $h-12 ." pm"; } - $result .= " </option>\n"; + $timest=&mt($timest); + $result .= $timest." </option>\n"; } $result .= " </select>\n"; $result .= " <input type=\"text\" name=\"$dname\_minute\" ".$special.' '. "value=\"$min\" size=\"3\" /> m\n"; $result .= " <input type=\"text\" name=\"$dname\_second\" ".$special.' '. "value=\"$sec\" size=\"3\" /> s\n"; - $result .= "<a href=\"javascript:$dname\_opencalendar()\">Select Date</a></nobr>\n<!-- end $dname date setting form -->\n"; + $result .= "<a href=\"javascript:$dname\_opencalendar()\">". + &mt('Select Date')."</a></nobr>\n<!-- end $dname date setting form -->\n"; return $result; } @@ -284,7 +369,7 @@ sub get_date_from_form { } if (defined($ENV{'form.'.$dname.'_hour'})) { my $tmphour = $ENV{'form.'.$dname.'_hour'}; - if (($tmphour =~ /^\d+$/) && ($tmphour > 0) && ($tmphour < 32)) { + if (($tmphour =~ /^\d+$/) && ($tmphour >= 0) && ($tmphour < 24)) { $hour = $tmphour; } } @@ -307,7 +392,9 @@ sub get_date_from_form { } } if (($year<70) || ($year>137)) { return undef; } - if (eval(&timelocal($sec,$min,$hour,$day,$month,$year))) { + if (defined($sec) && defined($min) && defined($hour) && + defined($day) && defined($month) && defined($year) && + eval(&timelocal($sec,$min,$hour,$day,$month,$year))) { return &timelocal($sec,$min,$hour,$day,$month,$year); } else { return undef; @@ -431,209 +518,12 @@ sub StatusOptions { $Str .= ' size="'.$size.'" '; $Str .= '>'."\n"; $Str .= '<option value="Active" '.$OpSel1.'>'. - 'Currently Enrolled</option>'."\n"; + &mt('Currently Enrolled').'</option>'."\n"; $Str .= '<option value="Expired" '.$OpSel2.'>'. - 'Previously Enrolled</option>'."\n"; + &mt('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)=@_; - - 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"; - } + &mt('Any Enrollment Status').'</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; } ######################################################## @@ -667,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. @@ -735,37 +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="Starting"></form>'. + '<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 @@ -779,16 +716,16 @@ sub Increment_PrgWin { if (int ($time_est/60) > 0) { my $min = int($time_est/60); my $sec = $time_est % 60; - $time_est = $min.' minutes'; + $time_est = $min.' '.&mt('minutes'); if ($min < 10) { if ($sec > 1) { - $time_est.= ', '.$sec.' seconds'; + $time_est.= ', '.$sec.' '.&mt('seconds'); } elsif ($sec > 0) { - $time_est.= ', '.$sec.' second'; + $time_est.= ', '.$sec.' '.&mt('second'); } } } else { - $time_est .= ' seconds'; + $time_est .= ' '.&mt('seconds'); } my $lasttime = &Time::HiRes::time()-$$prog_state{'laststart'}; if ($lasttime > 9) { @@ -799,9 +736,9 @@ sub Increment_PrgWin { $lasttime = sprintf("%3.2f",$lasttime); } if ($lasttime == 1) { - $lasttime = '('.$lasttime.' second for '.$extraInfo.')'; + $lasttime = '('.$lasttime.' '.&mt('second for').' '.$extraInfo.')'; } else { - $lasttime = '('.$lasttime.' seconds for '.$extraInfo.')'; + $lasttime = '('.$lasttime.' '.&mt('seconds for').' '.$extraInfo.')'; } # my $user_browser = $ENV{'browser.type'} if (exists($ENV{'browser.type'})); @@ -813,19 +750,89 @@ 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.' 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 + +sub crumbs { + my ($uri,$target,$prefix,$form)=@_; + my $output='<br /><tt><b><font size="+2">'.$prefix.'/'; + if ($ENV{'user.adv'}) { + my $path=$prefix.'/'; + foreach (split('/',$uri)) { + unless ($_) { next; } + $path.=$_; + unless ($path eq $uri) { $path.='/'; } + my $linkpath=$path; + if ($form) { + $linkpath="javascript:$form.action='$path';$form.submit();"; + } + $output.='<a href="'.$linkpath.'"'.($target?' target="'.$target.'"':'').'>'.$_.'</a>/'; + } + } else { + $output.=$uri; + } + unless ($uri=~/\/$/) { $output=~s/\/$//; } + 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;