--- loncom/interface/lonhtmlcommon.pm 2004/02/03 21:52:22 1.45 +++ loncom/interface/lonhtmlcommon.pm 2004/06/03 16:42:02 1.73 @@ -1,7 +1,7 @@ # The LearningOnline Network with CAPA # a pile of common html routines # -# $Id: lonhtmlcommon.pm,v 1.45 2004/02/03 21:52:22 albertel Exp $ +# $Id: lonhtmlcommon.pm,v 1.73 2004/06/03 16:42:02 www Exp $ # # Copyright Michigan State University Board of Trustees # @@ -56,10 +56,10 @@ html. package Apache::lonhtmlcommon; use Time::Local; +use Time::HiRes; use Apache::lonlocal; use strict; - ############################################## ############################################## @@ -163,14 +163,18 @@ sub textbox { ############################################## ############################################## sub checkbox { - my ($name,$value) = @_; - my $Str = '<input type="checkbox" name="'.$name.'"'. - ($value?' checked="1"':'').' />'; + my ($name,$checked,$value) = @_; + my $Str = '<input type="checkbox" name="'.$name.'" '; + if (defined($value)) { + $Str .= 'value="'.$value.'"'; + } + if ($checked) { + $Str .= ' checked="1"'; + } + $Str .= ' />'; return $Str; } - - ############################################## ############################################## @@ -203,6 +207,13 @@ Also, to be explicit, a value of 'now' a Additional html/javascript to be associated with each element in the date_setter. See lonparmset for example usage. +=item $includeempty + +=item $state + +Specifies the initial state of the form elements. Either 'disabled' or empty. +Defaults to empty, which indiciates the form elements are not disabled. + =back Bugs @@ -214,7 +225,14 @@ The method used to restrict user input w ############################################## ############################################## sub date_setter { - my ($formname,$dname,$currentvalue,$special,$includeempty) = @_; + my ($formname,$dname,$currentvalue,$special,$includeempty,$state, + $no_hh_mm_ss) = @_; + if (! defined($state) || $state ne 'disabled') { + $state = ''; + } + if (! defined($no_hh_mm_ss)) { + $no_hh_mm_ss = 0; + } if (! defined($currentvalue) || $currentvalue eq 'now') { unless ($includeempty) { $currentvalue = time; @@ -223,7 +241,7 @@ sub date_setter { } } # other potentially useful values: wkday,yrday,is_daylight_savings - my ($sec,$min,$hour,$mday,$month,$year)=('','','','','',''); + my ($sec,$min,$hour,$mday,$month,$year)=('','',undef,'','',''); if ($currentvalue) { ($sec,$min,$hour,$mday,$month,$year,undef,undef,undef) = localtime($currentvalue); @@ -263,19 +281,41 @@ sub date_setter { } } + function $dname\_disable() { + document.$formname.$dname\_month.disabled=true; + document.$formname.$dname\_day.disabled=true; + document.$formname.$dname\_year.disabled=true; + document.$formname.$dname\_hour.disabled=true; + document.$formname.$dname\_minute.disabled=true; + document.$formname.$dname\_second.disabled=true; + } + + function $dname\_enable() { + document.$formname.$dname\_month.disabled=false; + document.$formname.$dname\_day.disabled=false; + document.$formname.$dname\_year.disabled=false; + document.$formname.$dname\_hour.disabled=false; + document.$formname.$dname\_minute.disabled=false; + document.$formname.$dname\_second.disabled=false; + } + function $dname\_opencalendar() { - var calwin=window.open( + if (! document.$formname.$dname\_month.disabled) { + var calwin=window.open( "/adm/announcements?pickdate=yes&formname=$formname&element=$dname&month="+ document.$formname.$dname\_month.value+"&year="+ document.$formname.$dname\_year.value, "LONCAPAcal", "height=350,width=350,scrollbars=yes,resizable=yes,menubar=no"); + } } </script> ENDJS $result .= " <nobr><select name=\"$dname\_month\" ".$special.' '. + $state.' '. "onChange=\"javascript:$dname\_checkday()\" >\n"; + # Month 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 @@ -287,37 +327,47 @@ ENDJS $result .= "> ".&mt($Months[$m])." </option>\n"; } $result .= " </select>\n"; - $result .= " <input type=\"text\" name=\"$dname\_day\" ". + # Day + $result .= " <input type=\"text\" name=\"$dname\_day\" ".$state.' '. "value=\"$mday\" size=\"3\" ".$special.' '. "onChange=\"javascript:$dname\_checkday()\" />\n"; - $result .= " <input type=\"year\" name=\"$dname\_year\" ". + # Year + $result .= " <input type=\"year\" name=\"$dname\_year\" ".$state.' '. "value=\"$year\" size=\"5\" ".$special.' '. "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) { - $timest .= "12 am"; - } elsif($h == 12) { - $timest .= "12 noon"; - } elsif($h < 12) { - $timest .= "$h am"; - } else { - $timest .= $h-12 ." pm"; - } - $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"; + if (! $no_hh_mm_ss) { + # Hours + $result .= " <select name=\"$dname\_hour\" ".$special." ".$state.' '. + ">\n"; + if ($includeempty) { $result.="<option value=''></option>"; } + for (my $h = 0;$h<24;$h++) { + $result .= " <option value=\"$h\" "; + $result .= "selected " if (defined($hour) && $hour == $h); + $result .= "> "; + my $timest=''; + if ($h == 0) { + $timest .= "12 am"; + } elsif($h == 12) { + $timest .= "12 noon"; + } elsif($h < 12) { + $timest .= "$h am"; + } else { + $timest .= $h-12 ." pm"; + } + $timest=&mt($timest); + $result .= $timest." </option>\n"; + } + $result .= " </select>\n"; + $result .= " <input type=\"text\" name=\"$dname\_minute\" ". + $special.' '. + $state.' '. + "value=\"$min\" size=\"3\" /> m\n"; + $result .= " <input type=\"text\" name=\"$dname\_second\" ". + $special.' '. + $state.' '. + "value=\"$sec\" size=\"3\" /> s\n"; + } $result .= "<a href=\"javascript:$dname\_opencalendar()\">". &mt('Select Date')."</a></nobr>\n<!-- end $dname date setting form -->\n"; return $result; @@ -361,18 +411,26 @@ sub get_date_from_form { if (($tmpsec =~ /^\d+$/) && ($tmpsec >= 0) && ($tmpsec < 60)) { $sec = $tmpsec; } + if (!defined($tmpsec) || $tmpsec eq '') { $sec = 0; } + } else { + $sec = 0; } if (defined($ENV{'form.'.$dname.'_minute'})) { my $tmpmin = $ENV{'form.'.$dname.'_minute'}; if (($tmpmin =~ /^\d+$/) && ($tmpmin >= 0) && ($tmpmin < 60)) { $min = $tmpmin; } + if (!defined($tmpmin) || $tmpmin eq '') { $min = 0; } + } else { + $min = 0; } if (defined($ENV{'form.'.$dname.'_hour'})) { my $tmphour = $ENV{'form.'.$dname.'_hour'}; if (($tmphour =~ /^\d+$/) && ($tmphour >= 0) && ($tmphour < 24)) { $hour = $tmphour; } + } else { + $hour = 0; } if (defined($ENV{'form.'.$dname.'_day'})) { my $tmpday = $ENV{'form.'.$dname.'_day'}; @@ -527,203 +585,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 +616,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,42 +693,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)=@_; - #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('<script>'. - "var popwin; - function openpopwin () { - 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();}". - "\nwindow.setTimeout(openpopwin,0)</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,$heading.' <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 @@ -906,27 +809,43 @@ 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 sub crumbs { - my ($uri,$target,$prefix,$form)=@_; - my $output='<br /><tt><b><font size="+2">'.$prefix.'/'; + my ($uri,$target,$prefix,$form,$size)=@_; + if (! defined($size)) { + $size = '+2'; + } + my $output='<br /><tt><b><font size="'.$size.'">'.$prefix.'/'; if ($ENV{'user.adv'}) { my $path=$prefix.'/'; foreach (split('/',$uri)) { @@ -946,6 +865,207 @@ sub crumbs { return $output.'</font></b></tt><br />'; } +# ------------------------------------------------- Output headers for HTMLArea + +sub htmlareaheaders { + if (&htmlareablocked()) { return ''; } + my $lang='en'; + if (&mt('htmlarea_lang') ne 'htmlarea_lang') { + $lang=&mt('htmlarea_lang'); + } + return (<<ENDHEADERS); +<script type="text/javascript"> +_editor_url='/htmlarea/'; +_editor_lang='$lang'; +</script> +<script type="text/javascript" src="/htmlarea/htmlarea.js"></script> +ENDHEADERS +} + +# ---------------------------------------------------------- Script to activate + +sub htmlareaactive { + if (&htmlareablocked()) { return ''; } + return (<<ENDSCRIPT); +<script type="text/javascript" defer="1"> + HTMLArea.replaceAll(); +</script> +ENDSCRIPT +} + +# ----------------------------------------- Script to activate only some fields + +sub htmlareaselectactive { + my @fields=@_; + if (&htmlareablocked()) { return ''; } + my $output='<script type="text/javascript" defer="1">'; + foreach(@fields) { + $output.="\nHTMLArea.replace('$_');"; + } + $output.="\nwindow.status='Activated Editfields';\n</script>"; + return $output; +} + +# --------------------------------------------------------------------- Blocked + +sub htmlareablocked { + unless (&htmlareabrowser()) { return 1; } + return 0; +} + +# ---------------------------------------- Browser capable of running HTMLArea? + +sub htmlareabrowser { + return 1; +} + +############################################################ +############################################################ + +=pod + +=item breadcrumbs + +Compiles the previously registered breadcrumbs into an series of links. +FAQ and BUG links will be placed on the left side of the table if they +are defined for the last registered breadcrumb. +Additionally supports a 'component', which will be displayed on the +right side of the table (without a link). +A link to help for the component will be included if one is specified. + +All inputs can be undef without problems. + +Inputs: $color (the background color of the table returned), + $component (the large text on the right side of the table), + $component_help + $function (role to get colors from) + $domain (domian of role) + $menulink (boolean, controls whether to include a link to /adm/menu) + +Returns a string containing breadcrumbs for the current page. + +=item clear_breadcrumbs + +Clears the previously stored breadcrumbs. + +=item add_breadcrumb + +Pushes a breadcrumb on the stack of crumbs. + +input: $breadcrumb, a hash reference. The keys 'href','title', and 'text' +are required. If present the keys 'faq' and 'bug' will be used to provide +links to the FAQ and bug sites. + +returns: nothing + +=cut + +############################################################ +############################################################ +{ + my @Crumbs; + + sub breadcrumbs { + my ($color,$component,$component_help,$function,$domain,$menulink) = + @_; + if (! defined($color)) { + if (! defined($function)) { + $function = &Apache::loncommon::get_users_function(); + } + $color = &Apache::loncommon::designparm($function.'.tabbg', + $domain); + } + # + my $Str = "\n". + '<table width="100%" border="0" cellpadding="0" cellspacing="0">'. + '<tr><td bgcolor="'.$color.'">'. + '<font size="-1">'; + # + # Make the faq and bug data cascade + my $faq = ''; + my $bug = ''; + # The last breadcrumb does not have a link, so handle it separately. + my $last = pop(@Crumbs); + # + # The first one should be the course or a menu link + if (!defined($menulink)) { $menulink=1; } + if ($menulink) { + my $description = 'Menu'; + if (exists($ENV{'request.course.id'}) && + $ENV{'request.course.id'} ne '') { + $description = + $ENV{'course.'.$ENV{'request.course.id'}.'.description'}; + } + unshift(@Crumbs,{ + href =>'/adm/menu', + title =>'Go to main menu', + target =>'_top', + text =>$description, + }); + } + my $links .= + join('->', + map { + $faq = $_->{'faq'} if (exists($_->{'faq'})); + $bug = $_->{'bug'} if (exists($_->{'bug'})); + my $result = '<a href="'.$_->{'href'}.'" '; + if (defined($_->{'target'}) && $_->{'target'} ne '') { + $result .= 'target="'.$_->{'target'}.'" '; + } + $result .='title="'.&mt($_->{'title'}).'">'. + &mt($_->{'text'}).'</a>'; + $result; + } @Crumbs + ); + $links .= '->' if ($links ne ''); + $links .= '<b>'.$last->{'text'}.'</b>'; + # + my $icons = ''; + $faq = $last->{'faq'} if (exists($last->{'faq'})); + $bug = $last->{'bug'} if (exists($last->{'bug'})); + if ($faq ne '') { + $icons .= &Apache::loncommon::help_open_faq($faq); + } + if ($bug ne '') { + $icons .= &Apache::loncommon::help_open_bug($bug); + } + if ($icons ne '') { + $Str .= $icons.' '; + } + # + $Str .= $links.'</font></td>'; + # + if (defined($component)) { + $Str .= '<td align="right" bgcolor="'.$color.'">'. + '<font size="+1">'.&mt($component).'</font>'; + if (defined($component_help)) { + $Str .= + &Apache::loncommon::help_open_topic($component_help); + } + $Str.= '</td>'; + } + $Str .= '</tr></table>'."\n"; + # + # Return the @Crumbs stack to what we started with + push(@Crumbs,$last); + shift(@Crumbs); + # + return $Str; + } + + sub clear_breadcrumbs { + undef(@Crumbs); + } + + sub add_breadcrumb { + push (@Crumbs,@_); + } + +} # End of scope for @Crumbs + +############################################################ +############################################################ + 1;