--- loncom/interface/lonhtmlcommon.pm	2002/08/01 20:49:06	1.6
+++ loncom/interface/lonhtmlcommon.pm	2004/11/30 08:06:38	1.100
@@ -1,7 +1,7 @@
 # The LearningOnline Network with CAPA
 # a pile of common html routines
 #
-# $Id: lonhtmlcommon.pm,v 1.6 2002/08/01 20:49:06 stredwic Exp $
+# $Id: lonhtmlcommon.pm,v 1.100 2004/11/30 08:06:38 raeburn Exp $
 #
 # Copyright Michigan State University Board of Trustees
 #
@@ -25,109 +25,588 @@
 #
 # http://www.lon-capa.org/
 #
+######################################################################
+######################################################################
+
+=pod
+
+=head1 NAME
+
+Apache::lonhtmlcommon - routines to do common html things
+
+=head1 SYNOPSIS
+
+Referenced by other mod_perl Apache modules.
+
+=head1 INTRODUCTION
+
+lonhtmlcommon is a collection of subroutines used to present information
+in a consistent html format, or provide other functionality related to
+html.
+
+=head2 General Subroutines
+
+=over 4
+
+=cut 
+
+######################################################################
+######################################################################
 
 package Apache::lonhtmlcommon;
 
+use Time::Local;
+use Time::HiRes;
+use Apache::lonlocal;
 use strict;
 
-sub AscendOrderOptions {
-    my ($order, $page, $formName)=@_;
+##############################################
+##############################################
 
-    my $OpSel1 = '';
-    my $OpSel2 = '';
+=pod
 
-    if($order eq 'Ascending') {
-        $OpSel1 = ' selected';
-    } else {
-        $OpSel2 = ' selected';
+=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 '<a href="/adm/bombs/'.$url.
+		'"><img src="/adm/lonMisc/bomb.gif" border="0" /></a>'.
+		&Apache::loncommon::help_open_topic('About_Bombs');
+	}
     }
+    return '';
+}
 
-    my $Str = '';
-    $Str .= '<select name="'.(($page)?$page:'').'Ascend"';
-    if($formName) {
-        $Str .= ' onchange="document.'.$formName.'.submit()"';
+##############################################
+##############################################
+
+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]);
     }
-    $Str .= '>'."\n";
-    $Str .= '<option'.$OpSel1.'>Ascending</option>'."\n".
-	    '<option'.$OpSel2.'>Descending</option>'."\n";
-    $Str .= '</select>'."\n";
+# store new value
+    &Apache::lonnet::put($file,{ $name => 
+				 time.'&'.&Apache::lonnet::escape($value) });
+}
 
-    return $Str;
+sub remove_recent {
+    my ($area,$names)=@_;
+    my $file=&recent_filename($area);
+    return &Apache::lonnet::del($file,$names);
 }
 
-sub MapOptions {
-    my ($data, $page, $formName)=@_;
-    my $Str = '';
-    $Str .= '<select name="';
-    $Str .= (($page)?$page:'').'Maps"';
-    if($formName) {
-        $Str .= ' onchange="document.'.$formName.'.submit()"';
+sub select_recent {
+    my ($area,$fieldname,$event)=@_;
+    my %recent=&Apache::lonnet::dump(&recent_filename($area));
+    my $return="\n<select name='$fieldname'".
+	($event?" onchange='$event'":'').
+	">\n<option value=''>--- ".&mt('Recent')." ---</option>";
+    foreach (sort keys %recent) {
+	unless ($_=~/^error\:/) {
+	    my $escaped = &Apache::loncommon::escape_url($_);
+	    $return.="\n<option value='$escaped'>".
+		&Apache::lonnet::unescape((split(/\&/,$recent{$_}))[1]).
+		'</option>';
+	}
     }
-    $Str .= '>'."\n";
+    $return.="\n</select>\n";
+    return $return;
+}
 
-    my $selected = 0;
-    foreach my $sequence (split(':',$data->{'orderedSequences'})) {
-	$Str .= '<option';
-        if($data->{$page.'Map'} eq $data->{$sequence.':title'}) {
-            $Str .= ' selected';
-            $selected = 1;
-        }
-	$Str .= '>'.$data->{$sequence.':title'}.'</option>'."\n";	     
-    }
-    $Str .= '<option';
-    if(!$selected) {
-        $Str .= ' selected';
+sub get_recent {
+    my ($area, $n) = @_;
+    my %recent=&Apache::lonnet::dump(&recent_filename($area));
+
+# Create hash with key as time and recent as value
+    my %time_hash = ();
+    foreach (keys %recent) {
+        my $thistime=(split(/\&/,$recent{$_}))[0];
+        $time_hash{$thistime} = $_;
     }
-    $Str .= '>All Maps</option>'."\n";
 
-    $Str .= '</select>'."\n";
+# Sort by decreasing time and return key value pairs
+    my %return_hash = ();
+    my $idx = 1;
+    foreach (reverse sort keys %time_hash) {
+       $return_hash{$time_hash{$_}} =
+                  &Apache::lonnet::unescape((split(/\&/,$recent{$_}))[1]);
+       if ($n && ($idx++ >= $n)) {last;}
+    }
 
+    return %return_hash;
+}
+
+
+
+=pod
+
+=item textbox
+
+=cut
+
+##############################################
+##############################################
+sub textbox {
+    my ($name,$value,$size,$special) = @_;
+    $size = 40 if (! defined($size));
+    my $Str = '<input type="text" name="'.$name.'" size="'.$size.'" '.
+        'value="'.$value.'" '.$special.' />';
     return $Str;
 }
 
-sub StudentOptions {
-    my ($cache, $students, $selectedName, $page, $formName)=@_;
+##############################################
+##############################################
 
-    my $Str = '';
-    $Str .= '<select name="'.(($page)?$page:'').'Student"';
-    if($formName) {
-        $Str .= ' onchange="document.'.$formName.'.submit()"';
+=pod
+
+=item checkbox
+
+=cut
+
+##############################################
+##############################################
+sub checkbox {
+    my ($name,$checked,$value) = @_;
+    my $Str = '<input type="checkbox" name="'.$name.'" ';
+    if (defined($value)) {
+        $Str .= 'value="'.$value.'"';
+    } 
+    if ($checked) {
+        $Str .= ' checked="1"';
     }
-    $Str .= '>'."\n";
+    $Str .= ' />';
+    return $Str;
+}
+
+##############################################
+##############################################
+
+=pod
+
+=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
+
+=item $dname 
+
+The name to prepend to the form elements.  
+The form elements defined will be dname_year, dname_month, dname_day,
+dname_hour, dname_min, and dname_sec.
+
+=item $currentvalue
+
+The current setting for this time parameter.  A unix format time
+(time in seconds since the beginning of Jan 1st, 1970, GMT.  
+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.
+
+=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
 
-    my $selected=0;
+The method used to restrict user input will fail in the year 2400.
 
-    foreach (@$students) {
-	$Str .= '<option';
-	if($selectedName eq $_) {
-            $Str .= ' selected';
-            $selected = 1;
+=cut
+
+##############################################
+##############################################
+sub date_setter {
+    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;
+	} else {
+	    $currentvalue = 0;
+	}
+    }
+    # other potentially useful values:     wkday,yrday,is_daylight_savings
+    my ($sec,$min,$hour,$mday,$month,$year)=('','',undef,'','','');
+    if ($currentvalue) {
+	($sec,$min,$hour,$mday,$month,$year,undef,undef,undef) = 
+	    localtime($currentvalue);
+	$year += 1900;
+    }
+    my $result = "\n<!-- $dname date setting form -->\n";
+    $result .= <<ENDJS;
+<script language="Javascript">
+    function $dname\_checkday() {
+        var day   = document.$formname.$dname\_day.value;
+        var month = document.$formname.$dname\_month.value;
+        var year  = document.$formname.$dname\_year.value;
+        var valid = true;
+        if (day < 1) {
+            document.$formname.$dname\_day.value = 1;
+        } 
+        if (day > 31) {
+            document.$formname.$dname\_day.value = 31;
         }
-        $Str .= '>';
-        $Str .= $cache->{$_.':fullname'};
-        $Str .= '</option>'."\n";	     
+        if ((month == 1)  || (month == 3)  || (month == 5)  ||
+            (month == 7)  || (month == 8)  || (month == 10) ||
+            (month == 12)) {
+            if (day > 31) {
+                document.$formname.$dname\_day.value = 31;
+                day = 31;
+            }
+        } else if (month == 2 ) {
+            if ((year % 4 == 0) && (year % 100 != 0)) {
+                if (day > 29) {
+                    document.$formname.$dname\_day.value = 29;
+                }
+            } else if (day > 29) {
+                document.$formname.$dname\_day.value = 28;
+            }
+        } else if (day > 30) {
+            document.$formname.$dname\_day.value = 30;
+        }
+    }
+    
+    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;
     }
 
-    $Str .= '<option';
-    if($selectedName eq 'No Student Selected') {
-        $Str .= ' selected';
-        $selected = 1;
+    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;        
     }
-    $Str .= '>No Student Selected</option>'."\n";
 
-    $Str .= '<option';
-    if(!$selected) {
-        $Str .= ' selected';
+    function $dname\_opencalendar() {
+        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>';
+    my $monthselector = qq{<select name="$dname\_month" $special $state onchange="javascript:$dname\_checkday()" >};
+    # 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
+    unshift(@Months,'If you can read this an error occurred');
+    if ($includeempty) { $monthselector.="<option value=''></option>"; }
+    for(my $m = 1;$m <=$#Months;$m++) {
+        $monthselector .= qq{      <option value="$m" };
+        $monthselector .= "selected " if ($m-1 eq $month);
+        $monthselector .= '> '.&mt($Months[$m]).' </option>';
     }
-    $Str .= '>All Students</option>'."\n";
+    $monthselector.= '  </select>';
+    # Day
+    my $dayselector = qq{<input type="text" name="$dname\_day" $state value="$mday" size="3" $special onchange="javascript:$dname\_checkday()" />};
+    # Year
+    my $yearselector = qq{<input type="year" name="$dname\_year" $state value="$year" size="5" $special onchange="javascript:$dname\_checkday()" />};
+    #
+    my $hourselector = qq{<select name="$dname\_hour" $special $state >};
+    if ($includeempty) { 
+        $hourselector.=qq{<option value=''></option>};
+    }
+    for (my $h = 0;$h<24;$h++) {
+        $hourselector .= qq{<option value="$h" };
+        $hourselector .= "selected " if (defined($hour) && $hour == $h);
+        $hourselector .= ">";
+        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);
+        $hourselector .= $timest." </option>\n";
+    }
+    $hourselector .= "  </select>\n";
+    my $minuteselector = qq{<input type="text" name="$dname\_minute" $special $state value="$min" size="3" />};
+    my $secondselector= qq{<input type="text" name="$dname\_second" $special $state value="$sec" size="3" />};
+    my $cal_link = qq{<a href="javascript:$dname\_opencalendar()">};
+    #
+    if ($no_hh_mm_ss) {
+        $result .= &mt('[_1] [_2] [_3] [_4]Select Date[_5]',
+                       $monthselector,$dayselector,$yearselector,
+                       $cal_link,'</a>');
+    } else {
+        $result .= &mt('[_1] [_2] [_3] [_4] [_5]m [_6]s [_7]Select Date[_8]',
+                       $monthselector,$dayselector,$yearselector,
+                       $hourselector,$minuteselector,$secondselector,
+                       $cal_link,'</a>');
+    }
+    $result .= "</nobr>\n<!-- end $dname date setting form -->\n";
+    return $result;
+}
 
-    $Str .= '</select>'."\n";
+##############################################
+##############################################
+
+=pod
+
+=item &get_date_from_form
+
+get_date_from_form retrieves the date specified in an &date_setter form.
+
+Inputs:
+
+=over 4
+
+=item $dname
+
+The name passed to &datesetter, which prefixes the form elements.
+
+=item $defaulttime
+
+The unix time to use as the default in case of poor inputs.
+
+=back
+
+Returns: Unix time represented in the form.
+
+=cut
 
+##############################################
+##############################################
+sub get_date_from_form {
+    my ($dname) = @_;
+    my ($sec,$min,$hour,$day,$month,$year);
+    #
+    if (defined($ENV{'form.'.$dname.'_second'})) {
+        my $tmpsec = $ENV{'form.'.$dname.'_second'};
+        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'};
+        if (($tmpday =~ /^\d+$/) && ($tmpday > 0) && ($tmpday < 32)) {
+            $day = $tmpday;
+        }
+    }
+    if (defined($ENV{'form.'.$dname.'_month'})) {
+        my $tmpmonth = $ENV{'form.'.$dname.'_month'};
+        if (($tmpmonth =~ /^\d+$/) && ($tmpmonth > 0) && ($tmpmonth < 13)) {
+            $month = $tmpmonth - 1;
+        }
+    }
+    if (defined($ENV{'form.'.$dname.'_year'})) {
+        my $tmpyear = $ENV{'form.'.$dname.'_year'};
+        if (($tmpyear =~ /^\d+$/) && ($tmpyear > 1900)) {
+            $year = $tmpyear - 1900;
+        }
+    }
+    if (($year<70) || ($year>137)) { return undef; }
+    if (defined($sec) && defined($min)   && defined($hour) &&
+        defined($day) && defined($month) && defined($year) &&
+        eval(&timelocal($sec,$min,$hour,$day,$month,$year))) {
+        return &timelocal($sec,$min,$hour,$day,$month,$year);
+    } else {
+        return undef;
+    }
+}
+
+##############################################
+##############################################
+
+=pod
+
+=item &pjump_javascript_definition()
+
+Returns javascript defining the 'pjump' function, which opens up a
+parameter setting wizard.
+
+=cut
+
+##############################################
+##############################################
+sub pjump_javascript_definition {
+    my $Str = <<END;
+    function pjump(type,dis,value,marker,ret,call) {
+        parmwin=window.open("/adm/rat/parameter.html?type="+escape(type)
+                 +"&value="+escape(value)+"&marker="+escape(marker)
+                 +"&return="+escape(ret)
+                 +"&call="+escape(call)+"&name="+escape(dis),"LONCAPAparms",
+                 "height=350,width=350,scrollbars=no,menubar=no");
+    }
+END
     return $Str;
 }
 
+##############################################
+##############################################
+
+=pod
+
+=item &javascript_nothing()
+
+Return an appropriate null for the users browser.  This is used
+as the first arguement for window.open calls when you want a blank
+window that you can then write to.
+
+=cut
+
+##############################################
+##############################################
+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();
+    }
+    if ($user_browser eq 'explorer' && $user_os =~ 'mac') {
+        $nothing = "'javascript:void(0);'";
+    }
+    return $nothing;
+}
+
+##############################################
+##############################################
+sub javascript_docopen {
+    # safari does not understand document.open() and loads "text/html"
+    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();
+    }
+    if ($user_browser eq 'safari' && $user_os =~ 'mac') {
+        $nothing = "document.clear()";
+    } else {
+	$nothing = "document.open('text/html','replace')";
+    }
+    return $nothing;
+}
+
+
+##############################################
+##############################################
+
+=pod
+
+=item &StatusOptions()
+
+Returns html for a selection box which allows the user to choose the
+enrollment status of students.  The selection box name is 'Status'.
+
+Inputs:
+
+$status: the currently selected status.  If undefined the value of
+$ENV{'form.Status'} is taken.  If that is undefined, a value of 'Active'
+is used.
+
+$formname: The name of the form.  If defined the onchange attribute of
+the selection box is set to document.$formname.submit().
+
+$size: the size (number of lines) of the selection box.
+
+$onchange: javascript to use when the value is changed.  Enclosed in 
+double quotes, ""s, not single quotes.
+
+Returns: a perl string as described.
+
+=cut
+
+##############################################
+##############################################
 sub StatusOptions {
-    my ($status, $formName)=@_;
+    my ($status, $formName,$size,$onchange)=@_;
+    $size = 1 if (!defined($size));
+    if (! defined($status)) {
+        $status = 'Active';
+        $status = $ENV{'form.Status'} if (exists($ENV{'form.Status'}));
+    }
 
     my $OpSel1 = '';
     my $OpSel2 = '';
@@ -139,160 +618,578 @@ sub StatusOptions {
 
     my $Str = '';
     $Str .= '<select name="Status"';
-    if(defined($formName) && $formName ne '') {
+    if(defined($formName) && $formName ne '' && ! defined($onchange)) {
         $Str .= ' onchange="document.'.$formName.'.submit()"';
     }
+    if (defined($onchange)) {
+        $Str .= ' onchange="'.$onchange.'"';
+    }
+    $Str .= ' size="'.$size.'" ';
     $Str .= '>'."\n";
-    $Str .= '<option'.$OpSel1.'>Active</option>'."\n";
-    $Str .= '<option'.$OpSel2.'>Expired</option>'."\n";
-    $Str .= '<option'.$OpSel3.'>Any</option>'."\n";
+    $Str .= '<option value="Active" '.$OpSel1.'>'.
+        &mt('Currently Enrolled').'</option>'."\n";
+    $Str .= '<option value="Expired" '.$OpSel2.'>'.
+        &mt('Previously Enrolled').'</option>'."\n";
+    $Str .= '<option value="Any" '.$OpSel3.'>'.
+        &mt('Any Enrollment Status').'</option>'."\n";
     $Str .= '</select>'."\n";
 }
 
-sub MultipleSectionSelect {
-    my ($sections,$selectedSections)=@_;
+########################################################
+########################################################
 
-    my $Str = '';
-    $Str .= '<select name="Section" multiple="" size="4">'."\n";
+=pod
 
-    foreach (@$sections) {
-        $Str .= '<option';
-        foreach my $selected (@$selectedSections) {
-            if($_ eq $selected) {
-                $Str .= ' selected=""';
-            }
-        }
-        $Str .= '>'.$_.'</option>'."\n";
-    }
-    $Str .= '</select>'."\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 Title {
-    my ($pageName)=@_;
+=over 4
 
-    my $Str = '';
 
-    $Str .= '<html><head><title>'.$pageName.'</title></head>'."\n";
-    $Str .= '<body bgcolor="#FFFFFF">'."\n";
-    $Str .= '<script>window.focus(); window.width=500;window.height=500;';
-    $Str .= '</script>'."\n";
-    $Str .= '<table width="100%"><tr><td valign="top">';
-    $Str .= '<h1> Course: ';
-    $Str .= $ENV{'course.'.$ENV{'request.course.id'}.'.description'};
-    $Str .= '</h1></td><td align="right">'."\n";
-    $Str .= '<img align="right" src=/adm/lonIcons/lonlogos.gif>';
-    $Str .= '</td></tr></table>'."\n";
+=item &Create_PrgWin
 
-    return $Str;
-}
+Writes javascript to the client to open a progress window and returns a
+data structure used for bookkeeping.
 
-=pod
+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.
 
-=item &CreateTableHeadings()
+=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
 
-This function generates the column headings for the chart.
+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
 
-Inputs: $CacheData, $keyID, $headings, $spacePadding
+=item $r Apache request
 
-$CacheData: pointer to a hash tied to the cached data database
+=item $prog_state Pointer to the data structure returned by &Create_PrgWin
 
-$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 $displaystring The string to write to the status indicator
 
-$headings: The names of the headings for the student information
+=back
 
-$spacePadding: The spaces to go between columns
+Returns: none
 
-Output: $Str
 
-$Str: A formatted string of the table column headings.
+=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
 
-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/;
+########################################################
+########################################################
+
+my $uniq=0;
+sub get_uniq_name {
+    $uniq++;
+    return 'uniquename'.$uniq;
+}
+
+# Create progress
+sub Create_PrgWin {
+    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="'.$width.'" name="remaining" value="'.
+	      &mt('Starting').'"></form>'.
+              "</body></html>\');".
+        "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'));
+    }
+
+    $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,'<script>'.$$prog_state{'window'}.'.document.'.
+	     $$prog_state{'formname'}.'.'.
+	     $$prog_state{'inputname'}.'.value="'.
+	     $displayString.'";</script>');
+    $$prog_state{'laststart'}=&Time::HiRes::time();
+}
 
-        $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);
+    #
+    my $min = int($time_est/60);
+    my $sec = $time_est % 60;
+    # 
+    my $str;
+    if ($min == 0 && $sec > 1) {
+        $str = '[_2] seconds';
+    } elsif ($min == 1 && $sec > 1) {
+        $str = '1 minute [_2] seconds';
+    } elsif ($min == 1 && $sec < 2) {
+        $str = '1 minute';
+    } elsif ($min < 10 && $sec > 1) {
+        $str = '[_1] minutes, [_2] seconds';
+    } elsif ($min >= 10 || $sec < 2) {
+        $str = '[_1] minutes';
+    }
+    $time_est = &mt($str,$min,$sec);
+    #
+    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,'<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();
+}
 
-    return $Str;
+# close Progress Line
+sub Close_PrgWin {
+    my ($r,$prog_state)=@_;
+    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);
 }
 
-=pod
+sub r_print {
+    my ($r,$to_print)=@_;
+    if ($r) {
+	$r->print($to_print);
+	$r->rflush();
+    } else {
+	print($to_print);
+    }
+}
 
-=item &FormatStudentInformation()
+# ------------------------------------------------------- Puts directory header
 
-This function produces a formatted string of the student's information:
-username, domain, section, full name, and PID.
+sub crumbs {
+    my ($uri,$target,$prefix,$form,$size,$noformat)=@_;
+    if (! defined($size)) {
+        $size = '+2';
+    }
+    if ($target) {
+        $target = ' target="'.
+                  &Apache::loncommon::escape_single($target).'"';
+    }
+    my $output='';
+    unless ($noformat) { $output.='<br /><tt><b>'; }
+    $output.='<font size="'.$size.'">'.$prefix.'/';
+    if ($ENV{'user.adv'}) {
+	my $path=$prefix.'/';
+	foreach my $dir (split('/',$uri)) {
+            if (! $dir) { next; }
+            $path .= $dir;
+	    unless ($path eq $uri) { $path.='/'; }
+            my $linkpath = &Apache::loncommon::escape_single($path);
+            if ($form) {
+		$linkpath=
+                    qq{javascript:$form.action='$linkpath';$form.submit();};
+            }
+	    $output.=qq{<a href="$linkpath" $target>$dir</a>/};
+	}
+    } else {
+	$output.=$uri;
+    }
+    unless ($uri=~/\/$/) { $output=~s/\/$//; }
+    return $output.'</font>'.($noformat?'':'</b></tt><br />');
+}
 
-=over 4
+# --------------------- A function that generates a window for the spellchecker
 
-Input: $cache, $name, $keyID, $spacePadding
+sub spellheader {
+    my $nothing = &javascript_nothing();
+    return (<<ENDCHECK);
+<script type="text/javascript"> 
+//<!-- BEGIN LON-CAPA Internal
+var checkwin;
+
+function spellcheckerwindow() {
+    checkwin=window.open($nothing,'spellcheckwin','height=320,width=280,resizable=yes,scrollbars=yes,location=no,menubar=no,toolbar=no');
+    checkwin.document.writeln('<html><body bgcolor="#DDDDDD"><form name="spellcheckform" action="/adm/spellcheck" method="post"><input type="hidden" name="text" value="" /></form></body></html>');
+    checkwin.document.close();
+}
+// END LON-CAPA Internal -->
+</script>
+ENDCHECK
+}
 
-$cache: This is a pointer to a hash that is tied to the cached data
+# ---------------------------------- Generate link to spell checker for a field
 
-$name:  The name and domain of the current student in name:domain format
+sub spelllink {
+    my ($form,$field)=@_;
+    my $linktext=&mt('Check Spelling');
+    return (<<ENDLINK);
+<a href="javascript:if (typeof(document.$form.onsubmit)!='undefined') { document.$form.onsubmit();};spellcheckerwindow();checkwin.document.forms.spellcheckform.text.value=this.document.forms.$form.$field.value;checkwin.document.forms.spellcheckform.submit();">$linktext</a>
+ENDLINK
+}
 
-$keyID: A pointer to an array holding the names used to
+# ------------------------------------------------- Output headers for HTMLArea
 
-remove data from the hash.  They represent the name of the data to be removed.
+sub htmlareaheaders {
+    if (&htmlareablocked()) { return ''; }
+    unless (&htmlareabrowser()) { 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
+}
 
-$spacePadding: Extra spaces that represent the space between columns
+# ------------------------------------------------- Activate additional buttons
 
-Output: $Str
+sub htmlareaaddbuttons {
+    if (&htmlareablocked()) { return ''; }
+    unless (&htmlareabrowser()) { return ''; }
+    return (<<ENDADDBUTTON);
+    var config=new HTMLArea.Config();
+    config.registerButton('ed_math','LaTeX Inline',
+			  '/htmlarea/images/ed_math.gif',false,
+			    function(editor,id) {
+			      editor.surroundHTML('&nbsp;<m>\$','\$</m>&nbsp;');
+			    }
+			  );
+    config.registerButton('ed_math_eqn','LaTeX Equation',
+			  '/htmlarea/images/ed_math_eqn.gif',false,
+			    function(editor,id) {
+			      editor.surroundHTML(
+				     '&nbsp;\\n<center><m>\\\\[','\\\\]</m></center>\\n&nbsp;');
+			    }
+			  );
+    config.toolbar.push(['ed_math','ed_math_eqn']);
+ENDADDBUTTON
+}
 
-$Str: Formatted string.
+# ----------------------------------------------------------------- Preferences
 
-=back
+sub disablelink {
+    my @fields=@_;
+    if (defined($#fields)) {
+	unless ($#fields>=0) { return ''; }
+    }
+    return '<a href="'.&HTML::Entities::encode('/adm/preferences?action=set_wysiwyg&wysiwyg=off&returnurl=','<>&"').&Apache::lonnet::escape($ENV{'REQUEST_URI'}).'">'.&mt('Disable WYSIWYG Editor').'</a>';
+}
 
-=cut
+sub enablelink {
+    my @fields=@_;
+    if (defined($#fields)) {
+	unless ($#fields>=0) { return ''; }
+    }
+    return '<a href="'.&HTML::Entities::encode('/adm/preferences?action=set_wysiwyg&wysiwyg=on&returnurl=','<>&"').&Apache::lonnet::escape($ENV{'REQUEST_URI'}).'">'.&mt('Enable WYSIWYG Editor').'</a>';
+}
+
+# ----------------------------------------- Script to activate only some fields
+
+sub htmlareaselectactive {
+    my @fields=@_;
+    unless (&htmlareabrowser()) { return ''; }
+    if (&htmlareablocked()) { return '<br />'.&enablelink(@fields); }
+    my $output='<script type="text/javascript" defer="1">'.
+	&htmlareaaddbuttons();
+    foreach(@fields) {
+	$output.="\nHTMLArea.replace('$_',config);";
+    }
+    $output.="\nwindow.status='Activated Editfields';\n</script><br />".
+	&disablelink(@fields);
+    return $output;
+}
+
+# --------------------------------------------------------------------- Blocked
+
+sub htmlareablocked {
+    unless ($ENV{'environment.wysiwygeditor'} eq 'on') { 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.
 
-sub FormatStudentInformation {
-    my ($data,$name,$keyID,$displayString,$format)=@_;
-    my $Str='';
-    my $currentColumn;
+=item clear_breadcrumbs
 
-    for(my $index=0; $index<(scalar @$keyID); $index++) {
-        $currentColumn=$data->{$name.':'.$keyID->[$index]};
+Clears the previously stored breadcrumbs.
 
-        if($format eq 'preformatted') {
-            my @dataLength=split(//,$currentColumn);
-            my $length=scalar @dataLength;
-            $currentColumn.= (' 'x
-                     ($data->{$keyID->[$index].':columnWidth'}-$length));
+=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,
+	    $helplink) = @_;
+        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('-&gt;',
+                 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 .= '-&gt;' if ($links ne '');
+        $links .= '<b>'.&mt($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 ($helplink ne 'nohelp') {
+	    $icons .= &Apache::loncommon::help_open_menu($color,$component,$component_help,$function,$faq,$bug);
+	}
+        if ($icons ne '') {
+            $Str .= $icons.'&nbsp;';
+        }
+        #
+        $Str .= $links.'</font></td>';
+        #
+        if (defined($component)) {
+            $Str .= '<td align="right" bgcolor="'.$color.'">'.
+                '<font size="+1">'.&mt($component).'</font></td>';
+        }
+        $Str .= '</tr></table>'."\n";
+        #
+        # Return the @Crumbs stack to what we started with
+        push(@Crumbs,$last);
+        shift(@Crumbs);
+        #
+        return $Str;
+    }
 
-        my $tempString = $displayString;
-        $tempString =~ s/DISPLAYDATA/$currentColumn/;
+    sub clear_breadcrumbs {
+        undef(@Crumbs);
+    }
 
-        $Str .= $tempString;
+    sub add_breadcrumb {
+        push (@Crumbs,@_);
     }
 
-    return $Str;
-}
+} # End of scope for @Crumbs
+
+############################################################
+############################################################
+
 
 1;
+
 __END__