--- loncom/interface/lonhtmlcommon.pm 2003/01/14 22:01:56 1.11 +++ loncom/interface/lonhtmlcommon.pm 2004/01/29 00:51:06 1.43 @@ -1,7 +1,7 @@ # The LearningOnline Network with CAPA # a pile of common html routines # -# $Id: lonhtmlcommon.pm,v 1.11 2003/01/14 22:01:56 minaeibi Exp $ +# $Id: lonhtmlcommon.pm,v 1.43 2004/01/29 00:51:06 www Exp $ # # Copyright Michigan State University Board of Trustees # @@ -56,8 +56,121 @@ html. package Apache::lonhtmlcommon; use Time::Local; +use Apache::lonlocal; 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 ''. + &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\n"; + return $return; +} + + +=pod + +=item textbox + +=cut + +############################################## +############################################## +sub textbox { + my ($name,$value,$size,$special) = @_; + $size = 40 if (! defined($size)); + my $Str = ''; + return $Str; +} + +############################################## +############################################## + +=pod + +=item checkbox + +=cut + +############################################## +############################################## +sub checkbox { + my ($name,$value) = @_; + my $Str = ''; + return $Str; +} + + + ############################################## ############################################## @@ -65,6 +178,9 @@ use strict; =item &date_setter +&date_setter returns html and javascript for a compact date-setting form. +To retrieve values from it, use &get_date_from_form(). + Inputs =over 4 @@ -82,19 +198,37 @@ The current setting for this time parame 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. +=item $special + +Additional html/javascript to be associated with each element in +the date_setter. See lonparmset for example usage. + +=back + +Bugs + +The method used to restrict user input will fail in the year 2400. + =cut ############################################## ############################################## sub date_setter { - my ($formname,$dname,$currentvalue) = @_; + 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\n"; $result .= < @@ -128,57 +262,76 @@ sub date_setter { document.$formname.$dname\_day.value = 30; } } + + function $dname\_opencalendar() { + 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"); + + } ENDJS - $result .= " \n"; $result .= " \n"; $result .= " \n"; $result .= "  "; - $result .= " \n"; + if ($includeempty) { $result.=""; } for (my $h = 0;$h<24;$h++) { $result .= " '."\n"; - } - $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"; - } - } +############################################## +############################################## +sub javascript_nothing { + # mozilla and other browsers work with "''", but IE on mac does not. + my $nothing = "''"; + my $user_browser; + my $user_os; + $user_browser = $ENV{'browser.type'} if (exists($ENV{'browser.type'})); + $user_os = $ENV{'browser.os'} if (exists($ENV{'browser.os'})); + if (! defined($user_browser) || ! defined($user_os)) { + (undef,$user_browser,undef,undef,undef,$user_os) = + &Apache::loncommon::decode_user_agent(); } - $Str .= '{$page.'PartSelect'} eq $part) { - $Str .= ' selected'; - $selected = 1; - } - $Str .= '>'.$part.''."\n"; - } - $Str .= '{$_.':fullname'}; - $Str .= ''."\n"; - } +$onchange: javascript to use when the value is changed. Enclosed in +double quotes, ""s, not single quotes. - $Str .= 'Active'."\n"; - $Str .= 'Expired'."\n"; - $Str .= 'Any'."\n"; + $Str .= ''."\n"; + $Str .= ''."\n"; + $Str .= ''."\n"; $Str .= ''."\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)=@_; @@ -454,10 +572,29 @@ sub MultipleSectionSelect { $Str .= '>'.$_.''."\n"; } $Str .= ''."\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 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. + +=cut + +######################################################## +######################################################## sub Title { my ($pageName)=@_; @@ -471,9 +608,12 @@ sub Title { return $Str; } +######################################################## +######################################################## + =pod -=item &CreateTableHeadings() +=item &CreateHeadings() This function generates the column headings for the chart. @@ -498,6 +638,8 @@ $Str: A formatted string of the table co =cut +######################################################## +######################################################## sub CreateHeadings { my ($data,$keyID,$headings,$displayString,$format)=@_; my $Str=''; @@ -524,6 +666,9 @@ sub CreateHeadings { return $Str; } +######################################################## +######################################################## + =pod =item &FormatStudentInformation() @@ -553,6 +698,8 @@ $Str: Formatted string. =cut +######################################################## +######################################################## sub FormatStudentInformation { my ($data,$name,$keyID,$displayString,$format)=@_; my $Str=''; @@ -577,37 +724,225 @@ sub FormatStudentInformation { return $Str; } +######################################################## +######################################################## + +=pod + +=item Progess Window Handling Routines + +These routines handle the creation, update, increment, and closure of +progress windows. The progress window reports to the user the number +of items completed and an estimate of the time required to complete the rest. + +=over 4 + + +=item &Create_PrgWin + +Writes javascript to the client to open a progress window and returns a +data structure used for bookkeeping. + +Inputs + +=over 4 + +=item $r Apache request + +=item $title The title of the progress window + +=item $heading A description (usually 1 line) of the process being initiated. + +=item $number_to_do The total number of items being processed. + +=back + +Returns a hash containing the progress state data structure. + + +=item &Update_PrgWin + +Updates the text in the progress indicator. Does not increment the count. +See &Increment_PrgWin. + +Inputs: + +=over 4 + +=item $r Apache request + +=item $prog_state Pointer to the data structure returned by &Create_PrgWin + +=item $displaystring The string to write to the status indicator + +=back + +Returns: none + + +=item Increment_PrgWin + +Increment the count of items completed for the progress window by 1. + +Inputs: + +=over 4 + +=item $r Apache request + +=item $prog_state Pointer to the data structure returned by Create_PrgWin + +=item $extraInfo A description of the items being iterated over. Typically +'student'. + +=back + +Returns: none + + +=item Close_PrgWin + +Closes the progress window. + +Inputs: + +=over 4 + +=item $r Apache request + +=item $prog_state Pointer to the data structure returned by Create_PrgWin + +=back + +Returns: none + +=back + +=cut + +######################################################## +######################################################## + # Create progress sub Create_PrgWin { - my ($r, $title, $heading)=@_; + my ($r, $title, $heading, $number_to_do)=@_; $r->print('<script>'. "popwin=open(\'\',\'popwin\',\'width=400,height=100\');". - "popwin.document.writeln(\'<html><body bgcolor=\"#88DDFF\">". - "<title>$title". + "popwin.document.writeln(\'$title". + "". "

$heading

". "
". - "
". + ''. "\');". "popwin.document.close();". ""); + 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 ($displayString,$r)=@_; + my ($r,$prog_state,$displayString)=@_; $r->print(''); + $$prog_state{'laststart'}=&Time::HiRes::time(); + $r->rflush(); +} + +# increment progress state +sub Increment_PrgWin { + my ($r,$prog_state,$extraInfo)=@_; + $$prog_state{'done'}++; + my $time_est= (&Time::HiRes::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.' '.&mt('minutes'); + if ($min < 10) { + if ($sec > 1) { + $time_est.= ', '.$sec.' '.&mt('seconds'); + } elsif ($sec > 0) { + $time_est.= ', '.$sec.' '.&mt('second'); + } + } + } else { + $time_est .= ' '.&mt('seconds'); + } + my $lasttime = &Time::HiRes::time()-$$prog_state{'laststart'}; + if ($lasttime > 9) { + $lasttime = int($lasttime); + } elsif ($lasttime < 0.01) { + $lasttime = 0; + } else { + $lasttime = sprintf("%3.2f",$lasttime); + } + if ($lasttime == 1) { + $lasttime = '('.$lasttime.' '.&mt('second for').' '.$extraInfo.')'; + } else { + $lasttime = '('.$lasttime.' '.&mt('seconds for').' '.$extraInfo.')'; + } + # + my $user_browser = $ENV{'browser.type'} if (exists($ENV{'browser.type'})); + my $user_os = $ENV{'browser.os'} if (exists($ENV{'browser.os'})); + if (! defined($user_browser) || ! defined($user_os)) { + (undef,$user_browser,undef,undef,undef,$user_os) = + &Apache::loncommon::decode_user_agent(); + } + if ($user_browser eq 'explorer' && $user_os =~ 'mac') { + $lasttime = ''; + } + $r->print(''); + $$prog_state{'laststart'}=&Time::HiRes::time(); $r->rflush(); } # close Progress Line sub Close_PrgWin { - my ($r)=@_; + my ($r,$prog_state)=@_; $r->print(''."\n"); + undef(%$prog_state); $r->rflush(); } + +# ------------------------------------------------------- Puts directory header + +sub crumbs { + my ($uri,$target,$prefix,$form)=@_; + my $output='
'.$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.=''.$_.'/'; + } + } else { + $output.=$uri; + } + unless ($uri=~/\/$/) { $output=~s/\/$//; } + return $output.'
'; +} + + 1; + __END__