--- loncom/interface/lonhtmlcommon.pm 2003/03/10 20:25:00 1.18 +++ loncom/interface/lonhtmlcommon.pm 2003/07/25 19:56:37 1.28 @@ -1,7 +1,7 @@ # The LearningOnline Network with CAPA # a pile of common html routines # -# $Id: lonhtmlcommon.pm,v 1.18 2003/03/10 20:25:00 matthew Exp $ +# $Id: lonhtmlcommon.pm,v 1.28 2003/07/25 19:56:37 matthew Exp $ # # Copyright Michigan State University Board of Trustees # @@ -58,6 +58,45 @@ package Apache::lonhtmlcommon; use Time::Local; use strict; + +############################################## +############################################## + +=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) = @_; + my $Str = ''; + return $Str; +} + + + ############################################## ############################################## @@ -65,6 +104,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,12 +124,23 @@ 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) = @_; if (! defined($currentvalue) || $currentvalue eq 'now') { $currentvalue = time; } @@ -130,7 +183,7 @@ sub date_setter { } ENDJS - $result .= " \n"; $result .= " \n"; $result .= " \n"; $result .= "  "; - $result .= " \n"; for (my $h = 0;$h<24;$h++) { $result .= " '."\n". - 'Descending'."\n"; - $Str .= ''."\n"; - - return $Str; -} - -sub MapOptions { - my ($data, $page, $formName)=@_; - my $Str = ''; - $Str .= ''."\n"; } @@ -672,6 +629,102 @@ sub FormatStudentInformation { ######################################################## ######################################################## +=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, $number_to_do)=@_; @@ -681,15 +734,15 @@ sub Create_PrgWin { "". "

$heading

". "
". - "
". + ''. "\');". "popwin.document.close();". ""); my %prog_state; $prog_state{'done'}=0; - $prog_state{'firststart'}=time; - $prog_state{'laststart'}=time; + $prog_state{'firststart'}=&Time::HiRes::time(); + $prog_state{'laststart'}=&Time::HiRes::time(); $prog_state{'max'}=$number_to_do; $r->rflush(); @@ -701,7 +754,7 @@ sub Update_PrgWin { my ($r,$prog_state,$displayString)=@_; $r->print(''); - $$prog_state{'laststart'}=time; + $$prog_state{'laststart'}=&Time::HiRes::time(); $r->rflush(); } @@ -709,27 +762,51 @@ sub Update_PrgWin { sub Increment_PrgWin { my ($r,$prog_state,$extraInfo)=@_; $$prog_state{'done'}++; - my $time_est= (time - $$prog_state{'firststart'})/$$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.' minutes'; - if ($sec > 1) { - $time_est.= ', '.$sec.' seconds'; - } elsif ($sec > 0) { - $time_est.= ', '.$sec.' second'; - } + if ($min < 10) { + if ($sec > 1) { + $time_est.= ', '.$sec.' seconds'; + } elsif ($sec > 0) { + $time_est.= ', '.$sec.' second'; + } + } } else { $time_est .= ' 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.' second for '.$extraInfo.')'; + } else { + $lasttime = '('.$lasttime.' 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; + ': '.$time_est.' remaining '.$lasttime.'";'.''); + $$prog_state{'laststart'}=&Time::HiRes::time(); $r->rflush(); } @@ -742,4 +819,5 @@ sub Close_PrgWin { } 1; + __END__