';
- $Str .= 'Course: '; - $Str .= $ENV{'course.'.$ENV{'request.course.id'}.'.description'}; - $Str .= ' | '."\n";
- $Str .= ' ';
- $Str .= ' |
Current Time: '.localtime(time).'
'."\n"; +=item Progess Window Handling Routines - return $Str; -} +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. -sub CreateStatisticsMainMenu { - my ($status, $reports)=@_; +=over 4 - my $Str = ''; - $Str .= '
| '."\n"; - $Str .= ' | Analysis Reports: | '."\n"; - $Str .= 'Student Status: | |
| {'reportSelected'} eq $reports->{$_}) { - $Str .= ' selected=""'; - } - $Str .= '>'.$reports->{$_}.''."\n"; - } - $Str .= ' | '."\n"; +=item &Create_PrgWin - $Str .= ''; - $Str .= &StatusOptions($status, 'Statistics'); - $Str .= ' | '."\n"; +Writes javascript to the client to open a progress window and returns a +data structure used for bookkeeping. - $Str .= '
'."\n"; +Inputs - return $Str; -} +=over 4 -=pod +=item $r Apache request -=item &CreateTableHeadings() +=item $title The title of the progress window -This function generates the column headings for the chart. +=item $heading A description (usually 1 line) of the process being initiated. -=over 4 +=item $number_to_do The total number of items being processed. + +=back -Inputs: $CacheData, $keyID, $headings, $spacePadding +Returns a hash containing the progress state data structure. -$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 +=item &Update_PrgWin -$headings: The names of the headings for the student information +Updates the text in the progress indicator. Does not increment the count. +See &Increment_PrgWin. -$spacePadding: The spaces to go between columns +Inputs: -Output: $Str +=over 4 + +=item $r Apache request + +=item $prog_state Pointer to the data structure returned by &Create_PrgWin -$Str: A formatted string of the table column headings. +=item $displaystring The string to write to the status indicator =back -=cut +Returns: none -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/; +=item Increment_PrgWin - $Str .= $tempString; - } +Increment the count of items completed for the progress window by 1. - return $Str; -} +Inputs: -=pod +=over 4 -=item &FormatStudentInformation() +=item $r Apache request -This function produces a formatted string of the student's information: -username, domain, section, full name, and PID. +=item $prog_state Pointer to the data structure returned by Create_PrgWin -=over 4 +=item $extraInfo A description of the items being iterated over. Typically +'student'. -Input: $cache, $name, $keyID, $spacePadding +=back -$cache: This is a pointer to a hash that is tied to the cached data +Returns: none -$name: The name and domain of the current student in name:domain format -$keyID: A pointer to an array holding the names used to +=item Close_PrgWin -remove data from the hash. They represent the name of the data to be removed. +Closes the progress window. -$spacePadding: Extra spaces that represent the space between columns +Inputs: -Output: $Str +=over 4 -$Str: Formatted string. +=item $r Apache request + +=item $prog_state Pointer to the data structure returned by Create_PrgWin + +=back + +Returns: none =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)); - } +######################################################## +######################################################## + +# 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('"); + + 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; - my $tempString = $displayString; - $tempString =~ s/DISPLAYDATA/$currentColumn/; + $r->rflush(); + return %prog_state; +} + +# update progress +sub Update_PrgWin { + my ($r,$prog_state,$displayString)=@_; + $r->print(''); + $$prog_state{'laststart'}=&Time::HiRes::time(); + $r->rflush(); +} - $Str .= $tempString; +# 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(); +} - return $Str; +# close Progress Line +sub Close_PrgWin { + 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__