--- loncom/interface/loncommon.pm	2002/07/09 17:15:58	1.45
+++ loncom/interface/loncommon.pm	2002/08/22 13:39:42	1.56
@@ -1,7 +1,7 @@
 # The LearningOnline Network with CAPA
 # a pile of common routines
 #
-# $Id: loncommon.pm,v 1.45 2002/07/09 17:15:58 matthew Exp $
+# $Id: loncommon.pm,v 1.56 2002/08/22 13:39:42 matthew Exp $
 #
 # Copyright Michigan State University Board of Trustees
 #
@@ -79,26 +79,48 @@ package Apache::loncommon;
 
 use strict;
 use Apache::lonnet();
-use POSIX qw(strftime);
+use GDBM_File;
+use POSIX qw(strftime mktime);
 use Apache::Constants qw(:common);
 use Apache::lonmsg();
 my $readit;
 
+=pod 
+
+=item Global Variables
+
+=over 4
+
+=cut
 # ----------------------------------------------- Filetypes/Languages/Copyright
 my %language;
 my %cprtag;
 my %fe; my %fd;
 my %category_extensions;
 
-# -------------------------------------------------------------- Thesaurus data
-my @therelated;
-my @theword;
-my @thecount;
-my %theindex;
-my $thetotalcount;
-my $thefuzzy=2;
-my $thethreshold=0.1/$thefuzzy;
-my $theavecount;
+# ---------------------------------------------- Thesaurus variables
+
+=pod
+
+=item %Keywords  
+
+A hash used by &keyword to determine if a word is considered a keyword.
+
+=item $thesaurus_db_file
+
+Scalar containing the full path to the thesaurus database.                 
+
+=cut
+
+my %Keywords;
+my $thesaurus_db_file;
+
+
+=pod
+
+=back
+
+=cut
 
 # ----------------------------------------------------------------------- BEGIN
 
@@ -114,7 +136,9 @@ thesaurus.tab, and filecategories.tab.
 # ----------------------------------------------------------------------- BEGIN
 
 BEGIN {
-
+    # Variable initialization
+    $thesaurus_db_file = $Apache::lonnet::perlvar{'lonTabDir'}."/thesaurus.db";
+    #
     unless ($readit) {
 # ------------------------------------------------------------------- languages
     {
@@ -171,26 +195,10 @@ BEGIN {
 	    }
 	}
     }
-# -------------------------------------------------------------- Thesaurus data
-    {
-	my $fh=Apache::File->new($Apache::lonnet::perlvar{'lonTabDir'}.
-	       '/thesaurus.dat');
-	if ($fh) {
-            while (<$fh>) {
-               my ($tword,$tindex,$tcount,$trelated)=split(/\@/,$_);
-               $theindex{$tword}=$tindex;
-               $theword[$tindex]=$tword;
-               $thecount[$tindex]=$tcount;
-               $thetotalcount+=$tcount;
-               $therelated[$tindex]=$trelated;
-	   }
-        }
-        $theavecount=$thetotalcount/$#thecount;
-    }
     &Apache::lonnet::logthis(
-              "<font color=yellow>INFO: Read file types and thesaurus</font>");
+              "<font color=yellow>INFO: Read file types</font>");
     $readit=1;
-}
+    }  # end of unless($readit) 
     
 }
 # ============================================================= END BEGIN BLOCK
@@ -234,7 +242,7 @@ of the element the selection from the se
 ###############################################################
 sub browser_and_searcher_javascript {
     return <<END;
-    var editbrowser;
+    var editbrowser = null;
     function openbrowser(formname,elementname,only,omit) {
         var url = '/res/?';
         if (editbrowser == null) {
@@ -431,10 +439,12 @@ END
 
 =pod
 
-=item help_open_topic($topic, $stayOnPage, $width, $height)
+=item help_open_topic($topic, $text, $stayOnPage, $width, $height)
 
 Returns a string corresponding to an HTML link to the given help $topic, where $topic corresponds to the name of a .tex file in /home/httpd/html/adm/help/tex, with underscores replaced by spaces.
 
+$text will optionally be linked to the same topic, allowing you to link text in addition to the graphic. If you do not want to link text, but wish to specify one of the later parameters, pass an empty string.
+
 $stayOnPage is a value that will be interpreted as a boolean. If true, the link will not open a new window. If false, the link will open a new window using Javascript. (Default is false.)
 
 $width and $height are optional numerical parameters that will override the width and height of the popped up window, which may be useful for certain help topics with big pictures included.
@@ -442,33 +452,37 @@ $width and $height are optional numerica
 =cut
 
 sub help_open_topic {
-    my ($topic, $stayOnPage, $width, $height) = @_;
+    my ($topic, $text, $stayOnPage, $width, $height) = @_;
+    $text = "" if (not defined $text);
     $stayOnPage = 0 if (not defined $stayOnPage);
     $width = 350 if (not defined $width);
     $height = 400 if (not defined $height);
     my $filename = $topic;
     $filename =~ s/ /_/g;
 
-    my $template;
+    my $template = "";
+    my $link;
 
     if (!$stayOnPage)
     {
-        $template = <<"ENDTEMPLATE";
-<a href="javascript:void(open('/adm/help/${filename}.hlp', 'Help for $topic', 'menubar=0,s
-crollbars=1,width=$width,height=$height'))"><image
-  src="/adm/help/gif/smallHelp.gif"
-  border="0" alt="(Help: $topic)"></a>
-ENDTEMPLATE
+	$link = "javascript:void(open('/adm/help/${filename}.hlp', 'Help_for_$topic', 'menubar=0,toolbar=1,scrollbars=1,width=$width,height=$height'))";
     }
     else
     {
-        $template = <<"ENDTEMPLATE";
-<a href="/adm/help/${filename}.hlp"><image
-  src="/adm/help/gif/smallHelp.gif"
-  border="0" alt="(Help: $topic)"></a>
-ENDTEMPLATE
+	$link = "/adm/help/${filename}.hlp";
+    }
+
+    # Add the text
+    if ($text ne "")
+    {
+	$template .= "<a href=\"$link\">$text</a> ";
     }
 
+    # Add the graphic
+    $template .= <<"ENDTEMPLATE";
+<a href="$link"><image src="/adm/help/gif/smallHelp.gif" border="0" alt="(Help: $topic)"></a>
+ENDTEMPLATE
+
     return $template;
 
 }
@@ -490,8 +504,6 @@ sub csv_translate {
 }
 
 ###############################################################
-
-###############################################################
 ##        Home server <option> list generating code          ##
 ###############################################################
 #-------------------------------------------
@@ -546,7 +558,7 @@ sub select_dom_form {
 
 =pod
 
-=item get_home_servers($domain)
+=item get_library_servers($domain)
 
 Returns a hash which contains keys like '103l3' and values like 
 'kirk.lite.msu.edu'.  All of the keys will be for machines in the
@@ -555,15 +567,15 @@ given $domain.
 =cut
 
 #-------------------------------------------
-sub get_home_servers {
+sub get_library_servers {
     my $domain = shift;
-    my %home_servers;
+    my %library_servers;
     foreach (keys(%Apache::lonnet::libserv)) {
         if ($Apache::lonnet::hostdom{$_} eq $domain) {
-            $home_servers{$_} = $Apache::lonnet::hostname{$_};
+            $library_servers{$_} = $Apache::lonnet::hostname{$_};
         }
     }
-    return %home_servers;
+    return %library_servers;
 }
 
 #-------------------------------------------
@@ -580,7 +592,7 @@ returns a string which contains an <opti
 #-------------------------------------------
 sub home_server_option_list {
     my $domain = shift;
-    my %servers = &get_home_servers($domain);
+    my %servers = &get_library_servers($domain);
     my $result = '';
     foreach (sort keys(%servers)) {
         $result.=
@@ -805,66 +817,119 @@ END
 ##   End Authentication changing form generation functions   ##
 ###############################################################
 
+###############################################################
+##                Thesaurus Functions                        ##
+###############################################################
 
+=pod
 
-# ---------------------------------------------------------- Is this a keyword?
+=item initialize_keywords
 
-sub keyword {
-    my $newword=shift;
-    $newword=~s/\W//g;
-    $newword=~tr/A-Z/a-z/;
-    my $tindex=$theindex{$newword};
-    if ($tindex) {
-        if ($thecount[$tindex]>$theavecount) {
-           return 1;
-        }
+Initializes the package variable %Keywords if it is empty.  Uses the
+package variable $thesaurus_db_file.
+
+=cut
+
+###################################################
+
+sub initialize_keywords {
+    return 1 if (scalar keys(%Keywords));
+    # If we are here, %Keywords is empty, so fill it up
+    #   Make sure the file we need exists...
+    if (! -e $thesaurus_db_file) {
+        &Apache::lonnet::logthis("Attempt to access $thesaurus_db_file".
+                                 " failed because it does not exist");
+        return 0;
+    }
+    #   Set up the hash as a database
+    my %thesaurus_db;
+    if (! tie(%thesaurus_db,'GDBM_File',
+              $thesaurus_db_file,&GDBM_READER(),0640)){
+        &Apache::lonnet::logthis("Could not tie \%thesaurus_db to ".
+                                 $thesaurus_db_file);
+        return 0;
+    } 
+    #  Get the average number of appearances of a word.
+    my $avecount = $thesaurus_db{'average.count'};
+    #  Put keywords (those that appear > average) into %Keywords
+    while (my ($word,$data)=each (%thesaurus_db)) {
+        my ($count,undef) = split /:/,$data;
+        $Keywords{$word}++ if ($count > $avecount);
+    }
+    untie %thesaurus_db;
+    # Remove special values from %Keywords.
+    foreach ('total.count','average.count') {
+        delete($Keywords{$_}) if (exists($Keywords{$_}));
     }
-    return 0;
+    return 1;
 }
-# -------------------------------------------------------- Return related words
 
-sub related {
-    my $newword=shift;
-    $newword=~s/\W//g;
-    $newword=~tr/A-Z/a-z/;
-    my $tindex=$theindex{$newword};
-    if ($tindex) {
-        my %found=();
-        foreach (split(/\,/,$therelated[$tindex])) {
-# - Related word found
-            my ($ridx,$rcount)=split(/\:/,$_);
-# - Direct relation index
-            my $directrel=$rcount/$thecount[$tindex];
-            if ($directrel>$thethreshold) {
-               foreach (split(/\,/,$therelated[$ridx])) {
-                  my ($rridx,$rrcount)=split(/\:/,$_);
-                  if ($rridx==$tindex) {
-# - Determine reverse relation index
-                     my $revrel=$rrcount/$thecount[$ridx];
-# - Calculate full index
-                     $found{$ridx}=$directrel*$revrel;
-                     if ($found{$ridx}>$thethreshold) {
-                        foreach (split(/\,/,$therelated[$ridx])) {
-                            my ($rrridx,$rrrcount)=split(/\:/,$_);
-                            unless ($found{$rrridx}) {
-                               my $revrevrel=$rrrcount/$thecount[$ridx];
-                               if (
-                          $directrel*$revrel*$revrevrel>$thethreshold
-                               ) {
-                                  $found{$rrridx}=
-                                       $directrel*$revrel*$revrevrel;
-                               }
-                            }
-                        }
-                     }
-                  }
-               }
-            }
+###################################################
+
+=pod
+
+=item keyword($word)
+
+Returns true if $word is a keyword.  A keyword is a word that appears more 
+than the average number of times in the thesaurus database.  Calls 
+&initialize_keywords
+
+=cut
+
+###################################################
+
+sub keyword {
+    return if (!&initialize_keywords());
+    my $word=lc(shift());
+    $word=~s/\W//g;
+    return exists($Keywords{$word});
+}
+
+###############################################################
+
+=pod 
+
+=item get_related_words
+
+Look up a word in the thesaurus.  Takes a scalar arguement and returns
+an array of words.  If the keyword is not in the thesaurus, an empty array
+will be returned.  The order of the words returned is determined by the
+database which holds them.
+
+Uses global $thesaurus_db_file.
+
+=cut
+
+###############################################################
+sub get_related_words {
+    my $keyword = shift;
+    my %thesaurus_db;
+    if (! -e $thesaurus_db_file) {
+        &Apache::lonnet::logthis("Attempt to access $thesaurus_db_file ".
+                                 "failed because the file does not exist");
+        return ();
+    }
+    if (! tie(%thesaurus_db,'GDBM_File',
+              $thesaurus_db_file,&GDBM_READER(),0640)){
+        return ();
+    } 
+    my @Words=();
+    if (exists($thesaurus_db{$keyword})) {
+        $_ = $thesaurus_db{$keyword};
+        (undef,@Words) = split/:/;  # The first element is the number of times
+                                    # the word appears.  We do not need it now.
+        for (my $i=0;$i<=$#Words;$i++) {
+            ($Words[$i],undef)= split/\,/,$Words[$i];
         }
     }
-    return ();
+    untie %thesaurus_db;
+    return @Words;
 }
 
+###############################################################
+##              End Thesaurus Functions                      ##
+###############################################################
+
 # ---------------------------------------------------------------- Language IDs
 sub languageids {
     return sort(keys(%language));
@@ -981,7 +1046,7 @@ sub get_previous_attempt {
 	} else {
 	  $value=$lasthash{$_};
 	}
-	if ($_ =~/$regexp$/) {$value = &$gradesub($value)}
+	if ($_ =~/$regexp$/ && (defined &$gradesub)) {$value = &$gradesub($value)}
 	$prevattempts.='<td>'.$value.'&nbsp;</td>';
       }
       $prevattempts.='</tr></table></td></tr></table>';
@@ -1039,6 +1104,140 @@ sub get_student_answers {
 
 ###############################################
 
+
+sub timehash {
+    my @ltime=localtime(shift);
+    return ( 'seconds' => $ltime[0],
+             'minutes' => $ltime[1],
+             'hours'   => $ltime[2],
+             'day'     => $ltime[3],
+             'month'   => $ltime[4]+1,
+             'year'    => $ltime[5]+1900,
+             'weekday' => $ltime[6],
+             'dayyear' => $ltime[7]+1,
+             'dlsav'   => $ltime[8] );
+}
+
+sub maketime {
+    my %th=@_;
+    return POSIX::mktime(
+        ($th{'seconds'},$th{'minutes'},$th{'hours'},
+         $th{'day'},$th{'month'}-1,$th{'year'}-1900,0,0,$th{'dlsav'}));
+}
+
+
+sub findallcourses {
+    my %courses=();
+    my $now=time;
+    foreach (keys %ENV) {
+	if ($_=~/^user\.role\.\w+\.\/(\w+)\/(\w+)/) {
+	    my ($starttime,$endtime)=$ENV{$_};
+            my $active=1;
+            if ($starttime) {
+		if ($now<$starttime) { $active=0; }
+            }
+            if ($endtime) {
+                if ($now>$endtime) { $active=0; }
+            }
+            if ($active) { $courses{$1.'_'.$2}=1; }
+        }
+    }
+    return keys %courses;
+}
+
+###############################################
+
+sub bodytag {
+    my ($title,$function,$addentries)=@_;
+    unless ($function) {
+	$function='student';
+        if ($ENV{'request.role'}=~/^(cc|in|ta|ep)/) {
+	    $function='coordinator';
+        }
+	if ($ENV{'request.role'}=~/^(su|dc|ad|li)/) {
+            $function='admin';
+        }
+        if (($ENV{'request.role'}=~/^(au|ca)/) ||
+            ($ENV{'REQUEST_URI'}=~/^(\/priv|\~)/)) {
+            $function='author';
+        }
+    }
+    my $img='';
+    my $pgbg='';
+    my $tabbg='';
+    my $font='';
+    my $link='';
+    my $alink='#CC0000';
+    my $vlink='';
+    if ($function eq 'admin') {
+        $img='admin';
+        $pgbg='#FFFFCC';
+        $tabbg='#CCCC99';
+        $font='#772200';
+        $link='#663300';
+        $vlink='#666600';
+    } elsif ($function eq 'coordinator') {
+        $img='coordinator';
+        $pgbg='#CCFFFF';
+        $tabbg='#CCCCFF';
+        $font='#000044';
+        $link='#003333';
+        $vlink='#006633';
+   } elsif ($function eq 'author') {
+        $img='author';
+        $pgbg='#CCFFFF';
+        $tabbg='#CCFFCC';
+        $font='#004400';
+        $link='#003333';
+        $vlink='#006666';
+    } else {
+        $img='student';
+        $pgbg='#FFFFAA';
+        $tabbg='#FF9900';
+        $font='#991100';
+        $link='#993300';
+        $vlink='#996600';
+    }
+# role and realm
+    my ($role,$realm)
+       =&Apache::lonnet::plaintext((split(/\./,$ENV{'request.role'}))[0]);
+# realm
+    if ($ENV{'request.course.id'}) {
+	$realm=
+         $ENV{'course.'.$ENV{'request.course.id'}.'.description'};
+    }
+    unless ($realm) { $realm='&nbsp;'; }
+# Set messages
+    my $messages=localtime();
+# Output
+    return(<<ENDBODY);
+<body bgcolor="$pgbg" text="$font" alink="$alink" vlink="$vlink" link="$link"
+$addentries>
+<table width="100%" cellspacing="0" border="0" cellpadding="0">
+<tr><td bgcolor="$font">
+<img src="/adm/lonInterFace/$img.jpg" /></td>
+<td bgcolor="$font"><font color='$pgbg'>$messages</font></td>
+</tr>
+<tr>
+<td rowspan="3" bgcolor="$tabbg">
+&nbsp;<font size="5"><b>$title</b></font>
+<td bgcolor="$tabbg"  align="right">
+<font size="2">
+    $ENV{'environment.firstname'}
+    $ENV{'environment.middlename'}
+    $ENV{'environment.lastname'}
+    $ENV{'environment.generation'}
+    </font>&nbsp;
+</td>
+</tr>
+<tr><td bgcolor="$tabbg" align="right">
+<font size="2">$role</font>&nbsp;
+</td></tr>
+<tr>
+<td bgcolor="$tabbg" align="right"><font size="2">$realm</font>&nbsp;</td></tr>
+</table><br>
+ENDBODY
+}
 ###############################################
 
 sub get_unprocessed_cgi {
@@ -1124,6 +1323,8 @@ sub upfile_store {
     return $datatoken;
 }
 
+=pod
+
 =item load_tmp_file($r)
 
 Load uploaded file from tmp, $r should be the HTTP Request object,
@@ -1145,6 +1346,8 @@ sub load_tmp_file {
     $ENV{'form.upfile'}=join('',@studentdata);
 }
 
+=pod
+
 =item upfile_record_sep()
 
 Separate uploaded file into records
@@ -1160,6 +1363,8 @@ sub upfile_record_sep {
     }
 }
 
+=pod
+
 =item record_sep($record)
 
 Separate a record into fields $record should be an item from the upfile_record_sep(), needs $ENV{'form.upfiletype'}
@@ -1210,6 +1415,8 @@ sub record_sep {
     return %components;
 }
 
+=pod
+
 =item upfile_select_html()
 
 return HTML code to select file and specify its type
@@ -1228,6 +1435,8 @@ sub upfile_select_html {
 ENDUPFORM
 }
 
+=pod
+
 =item csv_print_samples($r,$records)
 
 Prints a table of sample values from each column uploaded $r is an
@@ -1258,6 +1467,8 @@ sub csv_print_samples {
     $r->print('</tr></table><br />'."\n");
 }
 
+=pod
+
 =item csv_print_select_table($r,$records,$d)
 
 Prints a table to create associations between values and table columns.
@@ -1290,6 +1501,8 @@ sub csv_print_select_table {
     return $i;
 }
 
+=pod
+
 =item csv_samples_select_table($r,$records,$d)
 
 Prints a table of sample values from the upload and can make associate samples to internal names.