';
- $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. -Inputs: $CacheData, $studentInformation, $headings, $spacePadding +=item $type Either 'popup' or 'inline' (popup is assumed if nothing is + specified) -$CacheData: pointer to a hash tied to the cached data database +=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 -$studentInformation: 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 $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 -$headings: The names of the headings for the student information +=back -$spacePadding: The spaces to go between columns +Returns a hash containing the progress state data structure. -Output: $Str -$Str: A formatted string of the table column headings. +=item &Update_PrgWin -=back +Updates the text in the progress indicator. Does not increment the count. +See &Increment_PrgWin. -=cut +Inputs: -sub CreateStudentInformationHeadings { - my ($data,$studentInformation,$headings,$displayString)=@_; - my $Str=''; - - for(my $index=0; $index<(scalar @$headings); $index++) { -# if(!&ShouldShowColumn($data, 'ChartHeading'.$index)) { -# next; -# } - my $data=$headings->[$index]; - my $linkdata=$studentInformation->[$index]; - my $tempString = $displayString; - $tempString =~ s/LINKDATA/$linkdata/; - $tempString =~ s/DISPLAYDATA/$data/; - $Str .= $tempString; - } +=over 4 - return $Str; -} +=item $r Apache request -=pod +=item $prog_state Pointer to the data structure returned by &Create_PrgWin -=item &FormatStudentInformation() +=item $displaystring The string to write to the status indicator -This function produces a formatted string of the student's information: -username, domain, section, full name, and PID. +=back + +Returns: none + + +=item Increment_PrgWin + +Increment the count of items completed for the progress window by 1. + +Inputs: =over 4 -Input: $cache, $name, $studentInformation, $spacePadding +=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 + -$cache: This is a pointer to a hash that is tied to the cached data +=item Close_PrgWin -$name: The name and domain of the current student in name:domain format +Closes the progress window. -$studentInformation: A pointer to an array holding the names used to +Inputs: -remove data from the hash. They represent the name of the data to be removed. +=over 4 -$spacePadding: Extra spaces that represent the space between columns +=item $r Apache request -Output: $Str +=item $prog_state Pointer to the data structure returned by Create_PrgWin -$Str: Formatted string. +=back + +Returns: none =back =cut -sub FormatStudentInformation { - my ($cache,$name,$studentInformation,$spacePadding)=@_; - my $Str=''; - my $data; - - for(my $index=0; $index<(scalar @$studentInformation); $index++) { - if(!&ShouldShowColumn($cache, 'ChartHeading'.$index)) { - next; +######################################################## +######################################################## + +# Create progress +sub Create_PrgWin { + my ($r, $title, $heading, $number_to_do,$type,$formname,$inputname)=@_; + if (!defined($type)) { $type='popup'; } + 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,'"); + $prog_state{'formname'}='popremain'; + $prog_state{'inputname'}="remaining"; + } elsif ($type eq 'inline') { + $prog_state{'window'}='window'; + if (!$formname) { + &r_print($r,''); } + &Update_PrgWin($r,\%prog_state,&mt('Starting')); + } + + $prog_state{'done'}=0; + $prog_state{'firststart'}=&Time::HiRes::time(); + $prog_state{'laststart'}=&Time::HiRes::time(); + $prog_state{'max'}=$number_to_do; + + return %prog_state; +} + +# update progress +sub Update_PrgWin { + my ($r,$prog_state,$displayString)=@_; + &r_print($r,''); + $$prog_state{'laststart'}=&Time::HiRes::time(); +} + +# 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'); + } } - $data=$cache->{$name.':'.$studentInformation->[$index]}; - $Str .= $data; + } 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($r,''); + $$prog_state{'laststart'}=&Time::HiRes::time(); +} - my @dataLength=split(//,$data); - my $length=scalar @dataLength; - $Str .= (' 'x($cache->{$studentInformation->[$index].'Length'}- - $length)); - $Str .= $spacePadding; +# close Progress Line +sub Close_PrgWin { + my ($r,$prog_state)=@_; + if ($$prog_state{'type'} eq 'popup') { + &r_print($r,''."\n"); + } elsif ($$prog_state{'type'} eq 'inline') { + &Update_PrgWin($r,$prog_state,&mt('Done')); } + undef(%$prog_state); +} - return $Str; +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='
'.$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__