--- loncom/interface/loncommon.pm	2007/07/02 03:36:28	1.541
+++ loncom/interface/loncommon.pm	2007/07/25 23:20:38	1.554
@@ -1,7 +1,7 @@
 # The LearningOnline Network with CAPA
 # a pile of common routines
 #
-# $Id: loncommon.pm,v 1.541 2007/07/02 03:36:28 raeburn Exp $
+# $Id: loncommon.pm,v 1.554 2007/07/25 23:20:38 albertel Exp $
 #
 # Copyright Michigan State University Board of Trustees
 #
@@ -240,7 +240,7 @@ 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 {
@@ -524,7 +524,8 @@ function uncheckAll(field) {
     if (field.length > 0) {
         for (i = 0; i < field.length; i++) {
             field[i].checked = false ;
-        }     } else {
+        }
+    } else {
         field.checked = false ;
     }
 }
@@ -708,8 +709,7 @@ sub help_open_topic {
     my ($topic, $text, $stayOnPage, $width, $height) = @_;
     $text = "" if (not defined $text);
     $stayOnPage = 0 if (not defined $stayOnPage);
-    if ($env{'browser.interface'} eq 'textual' ||
-	$env{'environment.remote'} eq 'off' ) {
+    if ($env{'browser.interface'} eq 'textual') {
 	$stayOnPage=1;
     }
     $width = 350 if (not defined $width);
@@ -801,12 +801,17 @@ ENDOUTPUT
 # now just updates the help link and generates a blue icon
 sub help_open_menu {
     my ($topic,$component_help,$faq,$bug,$stayOnPage,$width,$height,$text) 
-	= @_;
-    
+	= @_;    
     $stayOnPage = 0 if (not defined $stayOnPage);
-    if ($env{'browser.interface'} eq 'textual' ||
-	$env{'environment.remote'} eq 'off' ) {
-	$stayOnPage=1;
+    # formerly only used pop-up help (stayOnPage = 0)
+    # if environment.remote is on (using remote control UI)
+    # if ($env{'browser.interface'} eq 'textual' ||
+    #	$env{'environment.remote'} eq 'off' ) {
+    #   $stayOnPage=1;
+    #}
+    # Now making pop-up help the default even with remote control
+    if ($env{'browser.interface'} eq 'textual') {
+        $stayOnPage=1;
     }
     my $output;
     if ($component_help) {
@@ -1078,7 +1083,7 @@ sub changable_area {
 =pod
 
 =back
-
+ 
 =head1 Excel and CSV file utility routines
 
 =over 4
@@ -1212,7 +1217,7 @@ sub create_workbook {
 
 =item * create_text_file
 
-Create a file to write to and eventually make available to the usre.
+Create a file to write to and eventually make available to the user.
 If file creation fails, outputs an error message on the request object and 
 return undefs.
 
@@ -1262,8 +1267,10 @@ sub domain_select {
     } &Apache::lonnet::all_domains();
     if ($multiple) {
 	$domains{''}=&mt('Any domain');
+	$domains{'select_form_order'} = [sort {lc($a) cmp lc($b) } (keys(%domains))];
 	return &multiple_select_form($name,$value,4,\%domains);
     } else {
+	$domains{'select_form_order'} = [sort {lc($a) cmp lc($b) } (keys(%domains))];
 	return &select_form($name,$value,%domains);
     }
 }
@@ -1429,7 +1436,7 @@ selected");
 #-------------------------------------------
 sub select_dom_form {
     my ($defdom,$name,$includeempty) = @_;
-    my @domains = sort(&Apache::lonnet::all_domains());
+    my @domains = sort {lc($a) cmp lc($b)} (&Apache::lonnet::all_domains());
     if ($includeempty) { @domains=('',@domains); }
     my $selectdomain = "<select name=\"$name\" size=\"1\">\n";
     foreach my $dom (@domains) {
@@ -2119,6 +2126,19 @@ sub getnames {
     }
 }
 
+# -------------------------------------------------------------------- getemails
+=pod
+
+=item * getemails($uname,$udom)
+
+Gets a user's email information and returns it as a hash with keys:
+notification, critnotification, permanentemail
+
+For notification and critnotification, values are comma-separated lists 
+of e-mail address(es); for permanentemail, value is a single e-mail address.
+ 
+=cut
+
 sub getemails {
     my ($uname,$udom)=@_;
     if ($udom eq 'public' && $uname eq 'public') {
@@ -2140,6 +2160,15 @@ sub getemails {
     }
 }
 
+sub flush_email_cache {
+    my ($uname,$udom)=@_;
+    if (!$udom)  { $udom =$env{'user.domain'}; }
+    if (!$uname) { $uname=$env{'user.name'};   }
+    return if ($udom eq 'public' && $uname eq 'public');
+    my $id=$uname.':'.$udom;
+    &Apache::lonnet::devalidate_cache_new('emailscache',$id);
+}
+
 # ------------------------------------------------------------------ Screenname
 
 =pod
@@ -2213,7 +2242,8 @@ sub track_student_link {
         $target = '';
     }
     if ($start) { $link.='&amp;start='.$start; }
-    
+    $title = &mt($title);
+    $linktext = &mt($linktext);
     return qq{<a href="$link" title="$title" $target>$linktext</a>}.
 	&help_open_topic('View_recent_activity');
 }
@@ -3324,7 +3354,7 @@ sub designparm {
 
 =back
 
-=head1 HTTP Helpers
+=head1 HTML Helpers
 
 =over 4
 
@@ -3618,20 +3648,12 @@ sub make_attr_string {
 
 =pod
 
-=back
-
-=head1 HTML Helpers
-
-=over 4
-
 =item * &endbodytag()
 
 Returns a uniform footer for LON-CAPA web pages.
 
 Inputs: none
 
-=back
-
 =cut
 
 sub endbodytag {
@@ -3648,8 +3670,6 @@ sub endbodytag {
 
 =pod
 
-=over 4
-
 =item * &standard_css()
 
 Returns a style sheet
@@ -3660,8 +3680,6 @@ Inputs: (all optional)
             function       -> force usage of a specific rolish color scheme
             bgcolor        -> override the default page bgcolor
 
-=back
-
 =cut
 
 sub standard_css {
@@ -3733,6 +3751,10 @@ form, .inline { display: inline; }
 .LC_diff_added {
   color: green;
 }
+.LC_unknown {
+  color: yellow;
+}
+
 .LC_icon {
   border: 0px;
 }
@@ -3740,6 +3762,11 @@ form, .inline { display: inline; }
   border: 0px;
   height: 22px;
 }
+.LC_docs_spacer {
+  width: 25px;
+  height: 1px;
+  border: 0px;
+}
 
 .LC_internal_info {
   color: #999;
@@ -4409,7 +4436,74 @@ table.LC_prior_match tr td {
 }
 
 span.LC_nobreak {
-    white-space: nowrap;
+  white-space: nowrap;
+}
+
+table.LC_docs_documents {
+  background: #BBBBBB;
+  border-width: 0px;
+  border-collapse: collapse;
+}
+
+table.LC_docs_documents td.LC_docs_document {
+  border: 2px solid black;
+  padding: 4px;
+}
+
+.LC_docs_course_commands div {
+  float: left;
+  border: 4px solid #AAAAAA;
+  padding: 4px;
+  background: #DDDDCC;
+}
+
+.LC_docs_entry_move {
+  border: 0px;
+  border-collapse: collapse;
+}
+
+.LC_docs_entry_move td {
+  border: 2px solid #BBBBBB;
+  background: #DDDDDD;
+}
+
+.LC_docs_editor td.LC_docs_entry_commands {
+  background: #DDDDDD;
+  font-size: x-small;
+}
+.LC_docs_copy {
+  color: #000099;
+}
+.LC_docs_cut {
+  color: #550044;
+}
+.LC_docs_rename {
+  color: #009900;
+}
+.LC_docs_remove {
+  color: #990000;
+}
+
+.LC_docs_reinit_warn,
+.LC_docs_ext_edit {
+  font-size: x-small;
+}
+
+.LC_docs_editor td.LC_docs_entry_title,
+.LC_docs_editor td.LC_docs_entry_icon {
+  background: #FFFFBB;
+}
+.LC_docs_editor td.LC_docs_entry_parameter {
+  background: #BBBBFF;
+  font-size: x-small;
+  white-space: nowrap;
+}
+
+table.LC_docs_adddocs td,
+table.LC_docs_adddocs th {
+  border: 1px solid #BBBBBB;
+  padding: 4px;
+  background: #DDDDDD;
 }
 
 END
@@ -4417,8 +4511,6 @@ END
 
 =pod
 
-=over 4
-
 =item * &headtag()
 
 Returns a uniform footer for LON-CAPA web pages.
@@ -4442,8 +4534,6 @@ Inputs: $title - optional title for the
             no_auto_mt_title
                            -> prevent &mt()ing the title arg
 
-=back
-
 =cut
 
 sub headtag {
@@ -4499,16 +4589,12 @@ ADDMETA
 
 =pod
 
-=over 4
-
 =item * &font_settings()
 
 Returns neccessary <meta> to set the proper encoding
 
 Inputs: none
 
-=back
-
 =cut
 
 sub font_settings {
@@ -4525,16 +4611,12 @@ sub font_settings {
 
 =pod
 
-=over 4
-
 =item * &xml_begin()
 
 Returns the needed doctype and <html>
 
 Inputs: none
 
-=back
-
 =cut
 
 sub xml_begin {
@@ -4559,16 +4641,12 @@ sub xml_begin {
 
 =pod
 
-=over 4
-
 =item * &endheadtag()
 
 Returns a uniform </head> for LON-CAPA web pages.
 
 Inputs: none
 
-=back
-
 =cut
 
 sub endheadtag {
@@ -4577,8 +4655,6 @@ sub endheadtag {
 
 =pod
 
-=over 4
-
 =item * &head()
 
 Returns a uniform complete <head>..</head> section for LON-CAPA web pages.
@@ -4586,8 +4662,6 @@ Returns a uniform complete <head>..</hea
 Inputs: $title - optional title for the page
         $head_extra - optional extra HTML to put inside the <head>
 
-=back
-
 =cut
 
 sub head {
@@ -4597,8 +4671,6 @@ sub head {
 
 =pod
 
-=over 4
-
 =item * &start_page()
 
 Returns a complete <html> .. <body> section for LON-CAPA web pages.
@@ -4637,8 +4709,6 @@ Inputs: $title - optional title for the
 
                   no_auto_mt_title -> prevent &mt()ing the title arg
 
-=back
-
 =cut
 
 sub start_page {
@@ -4690,8 +4760,6 @@ sub start_page {
 
 =pod
 
-=over 4
-
 =item * &head()
 
 Returns a complete </body></html> section for LON-CAPA web pages.
@@ -4849,10 +4917,61 @@ sub simple_error_page {
     }
 }
 
+=pod
+
+=item * &inhibit_menu_check($arg)
+
+Checks for a inhibitmenu state and generates output to preserve it
+
+Inputs:         $arg - can be any of
+                     - undef - in which case the return value is a string 
+                               to add  into arguments list of a uri
+                     - 'input' - in which case the return value is a HTML
+                                 <form> <input> field of type hidden to
+                                 preserve the value
+                     - a url - in which case the return value is the url with
+                               the neccesary cgi args added to preserve the
+                               inhibitmenu state
+                     - a ref to a url - no return value, but the string is
+                                        updated to include the neccessary cgi
+                                        args to preserve the inhibitmenu state
+
+=cut
+
+sub inhibit_menu_check {
+    my ($arg) = @_;
+    &get_unprocessed_cgi($ENV{'QUERY_STRING'}, ['inhibitmenu']);
+    if ($arg eq 'input') {
+	if ($env{'form.inhibitmenu'}) {
+	    return '<input type="hidden" name="inhibitmenu" value="'.$env{'form.inhibitmenu'}.'" />';
+	} else {
+	    return
+	}
+    }
+    if ($env{'form.inhibitmenu'}) {
+	if (ref($arg)) {
+	    $$arg .= '?inhibitmenu='.$env{'form.inhibitmenu'};
+	} elsif ($arg eq '') {
+	    $arg .= 'inhibitmenu='.$env{'form.inhibitmenu'};
+	} else {
+	    $arg .= '?inhibitmenu='.$env{'form.inhibitmenu'};
+	}
+    }
+    if (!ref($arg)) {
+	return $arg;
+    }
+}
+
 ###############################################
 
 =pod
 
+=back
+
+=head1 User Information Routines
+
+=over 4
+
 =item * &get_users_function()
 
 Used by &bodytag to determine the current users primary role.
@@ -4880,7 +4999,7 @@ sub get_users_function {
 
 =pod
 
-=item * &check_user_status
+=item * &check_user_status()
 
 Determines current status of supplied role for a
 specific user. Roles can be active, previous or future.
@@ -5415,6 +5534,12 @@ sub get_secgrprole_info {
 
 =pod
 
+=back
+
+=head1 HTTP Helpers
+
+=over 4
+
 =item * get_unprocessed_cgi($query,$possible_names)
 
 Modify the %env hash to contain unprocessed CGI form parameters held in