--- loncom/interface/loncommon.pm	2002/06/25 17:09:38	1.41
+++ loncom/interface/loncommon.pm	2002/07/09 17:15:58	1.45
@@ -1,7 +1,7 @@
 # The LearningOnline Network with CAPA
 # a pile of common routines
 #
-# $Id: loncommon.pm,v 1.41 2002/06/25 17:09:38 ng Exp $
+# $Id: loncommon.pm,v 1.45 2002/07/09 17:15:58 matthew Exp $
 #
 # Copyright Michigan State University Board of Trustees
 #
@@ -33,6 +33,7 @@
 # 12/25,12/28 Gerd Kortemeyer
 # YEAR=2002
 # 1/4 Gerd Kortemeyer
+# 6/24,7/2 H. K. Ng
 
 # Makes a table out of the previous attempts
 # Inputs result_from_symbread, user, domain, course_id
@@ -40,6 +41,8 @@
 
 # POD header:
 
+=pod
+
 =head1 NAME
 
 Apache::loncommon - pile of common routines
@@ -104,9 +107,10 @@ my $theavecount;
 =item BEGIN() 
 
 Initialize values from language.tab, copyright.tab, filetypes.tab,
-and filecategories.tab.
+thesaurus.tab, and filecategories.tab.
 
 =cut
+
 # ----------------------------------------------------------------------- BEGIN
 
 BEGIN {
@@ -190,6 +194,92 @@ BEGIN {
     
 }
 # ============================================================= END BEGIN BLOCK
+###############################################################
+##           HTML and Javascript Helper Functions            ##
+###############################################################
+
+=pod 
+
+=item browser_and_searcher_javascript 
+
+Returns scalar containing javascript to open a browser window
+or a searcher window.  Also creates 
+
+=over 4
+
+=item openbrowser(formname,elementname,only,omit) [javascript]
+
+inputs: formname, elementname, only, omit
+
+formname and elementname indicate the name of the html form and name of
+the element that the results of the browsing selection are to be placed in. 
+
+Specifying 'only' will restrict the browser to displaying only files
+with the given extension.  Can be a comma seperated list.
+
+Specifying 'omit' will restrict the browser to NOT displaying files
+with the given extension.  Can be a comma seperated list.
+
+=item opensearcher(formname, elementname) [javascript]
+
+Inputs: formname, elementname
+
+formname and elementname specify the name of the html form and the name
+of the element the selection from the search results will be placed in.
+
+=back
+
+=cut
+
+###############################################################
+sub browser_and_searcher_javascript {
+    return <<END;
+    var editbrowser;
+    function openbrowser(formname,elementname,only,omit) {
+        var url = '/res/?';
+        if (editbrowser == null) {
+            url += 'launch=1&';
+        }
+        url += 'catalogmode=interactive&';
+        url += 'mode=edit&';
+        url += 'form=' + formname + '&';
+        if (only != null) {
+            url += 'only=' + only + '&';
+        } 
+        if (omit != null) {
+            url += 'omit=' + omit + '&';
+        }
+        url += 'element=' + elementname + '';
+        var title = 'Browser';
+        var options = 'scrollbars=1,resizable=1,menubar=0';
+        options += ',width=700,height=600';
+        editbrowser = open(url,title,options,'1');
+        editbrowser.focus();
+    }
+    var editsearcher;
+    function opensearcher(formname,elementname) {
+        var url = '/adm/searchcat?';
+        if (editsearcher == null) {
+            url += 'launch=1&';
+        }
+        url += 'catalogmode=interactive&';
+        url += 'mode=edit&';
+        url += 'form=' + formname + '&';
+        url += 'element=' + elementname + '';
+        var title = 'Search';
+        var options = 'scrollbars=1,resizable=1,menubar=0';
+        options += ',width=700,height=600';
+        editsearcher = open(url,title,options,'1');
+        editsearcher.focus();
+    }
+END
+}
+
+
+
+###############################################################
+
+=pod
 
 =item linked_select_forms(...)
 
@@ -255,8 +345,6 @@ my %menu = ( A1 => { text =>"Choice A1"
                   }
               );
 
-=back
-
 =cut
 
 # ------------------------------------------------
@@ -341,6 +429,52 @@ END
 
 ###############################################################
 
+=pod
+
+=item help_open_topic($topic, $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.
+
+$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.
+
+=cut
+
+sub help_open_topic {
+    my ($topic, $stayOnPage, $width, $height) = @_;
+    $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;
+
+    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
+    }
+    else
+    {
+        $template = <<"ENDTEMPLATE";
+<a href="/adm/help/${filename}.hlp"><image
+  src="/adm/help/gif/smallHelp.gif"
+  border="0" alt="(Help: $topic)"></a>
+ENDTEMPLATE
+    }
+
+    return $template;
+
+}
+
+=pod
+
 =item csv_translate($text) 
 
 Translate $text to allow it to be output as a 'comma seperated values' 
@@ -362,6 +496,8 @@ sub csv_translate {
 ###############################################################
 #-------------------------------------------
 
+=pod
+
 =item get_domains()
 
 Returns an array containing each of the domains listed in the hosts.tab
@@ -382,6 +518,8 @@ sub get_domains {
 
 #-------------------------------------------
 
+=pod
+
 =item select_dom_form($defdom,$name)
 
 Returns a string containing a <select name='$name' size='1'> form to 
@@ -406,6 +544,8 @@ sub select_dom_form {
 
 #-------------------------------------------
 
+=pod
+
 =item get_home_servers($domain)
 
 Returns a hash which contains keys like '103l3' and values like 
@@ -428,6 +568,8 @@ sub get_home_servers {
 
 #-------------------------------------------
 
+=pod
+
 =item home_server_option_list($domain)
 
 returns a string which contains an <option> list to be used in a 
@@ -460,6 +602,8 @@ sub home_server_option_list {
 ##    formname = the name given in the <form> tag.
 #-------------------------------------------
 
+=pod
+
 =item authform_xxxxxx
 
 The authform_xxxxxx subroutines provide javascript and html forms which 
@@ -778,13 +922,16 @@ sub filedescriptionex {
 # $username,$domain - that of the student
 # $course           - course name
 # $getattempt       - leave blank if want all attempts, else put something.
+# $regexp           - regular expression. If string matches regexp send to
+# $gradesub         - routine that process the string if it matches regexp
 # 
 # output
 # formatted as a table all the attempts, if any.
 #
 sub get_previous_attempt {
-  my ($symb,$username,$domain,$course,$getattempt)=@_;
+  my ($symb,$username,$domain,$course,$getattempt,$regexp,$gradesub)=@_;
   my $prevattempts='';
+  no strict 'refs';
   if ($symb) {
     my (%returnhash)=
       &Apache::lonnet::restore($symb,$course,$domain,$username);
@@ -796,7 +943,7 @@ sub get_previous_attempt {
 	  $lasthash{$_}=$returnhash{$version.':'.$_};
         }
       }
-      $prevattempts='<table border="0" width="100%"><tr><td bgcolor="#000000">';
+      $prevattempts='<table border="0" width="100%"><tr><td bgcolor="#777777">';
       $prevattempts.='<table border="0" width="100%"><tr bgcolor="#e6ffff"><td>History</td>';
       foreach (sort(keys %lasthash)) {
 	my ($ign,@parts) = split(/\./,$_);
@@ -834,6 +981,7 @@ sub get_previous_attempt {
 	} else {
 	  $value=$lasthash{$_};
 	}
+	if ($_ =~/$regexp$/) {$value = &$gradesub($value)}
 	$prevattempts.='<td>'.$value.'&nbsp;</td>';
       }
       $prevattempts.='</tr></table></td></tr></table>';
@@ -945,6 +1093,8 @@ sub add_to_env {
 
 =pod
 
+=back 
+
 =head2 CSV Upload/Handling functions
 
 =over 4