--- loncom/interface/loncommon.pm	2007/07/03 23:02:53	1.545
+++ loncom/interface/loncommon.pm	2007/08/15 16:25:14	1.563
@@ -1,7 +1,7 @@
 # The LearningOnline Network with CAPA
 # a pile of common routines
 #
-# $Id: loncommon.pm,v 1.545 2007/07/03 23:02:53 albertel Exp $
+# $Id: loncommon.pm,v 1.563 2007/08/15 16:25:14 raeburn Exp $
 #
 # Copyright Michigan State University Board of Trustees
 #
@@ -334,10 +334,12 @@ sub studentbrowser_javascript {
    return (<<'ENDSTDBRW');
 <script type="text/javascript" language="Javascript" >
     var stdeditbrowser;
-    function openstdbrowser(formname,uname,udom,roleflag) {
+    function openstdbrowser(formname,uname,udom,roleflag,ignorefilter) {
         var url = '/adm/pickstudent?';
         var filter;
-        eval('filter=document.'+formname+'.'+uname+'.value;');
+	if (!ignorefilter) {
+	    eval('filter=document.'+formname+'.'+uname+'.value;');
+	}
         if (filter != null) {
            if (filter != '') {
                url += 'filter='+filter+'&';
@@ -365,7 +367,7 @@ sub selectstudent_link {
 	   return '';
        }
        return "<a href='".'javascript:openstdbrowser("'.$form.'","'.$unameele.
-        '","'.$udomele.'");'."'>".&mt('Select User')."</a>";
+        '","'.$udomele.'","","1");'."'>".&mt('Select User')."</a>";
    }
    if ($env{'request.role'}=~/^(au|dc|su)/) {
        return "<a href='".'javascript:openstdbrowser("'.$form.'","'.$unameele.
@@ -709,8 +711,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);
@@ -802,12 +803,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) {
@@ -1263,8 +1269,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);
     }
 }
@@ -1416,7 +1424,7 @@ sub select_level_form {
 
 =pod
 
-=item * select_dom_form($defdom,$name,$includeempty)
+=item * select_dom_form($defdom,$name,$includeempty,$showdomdesc)
 
 Returns a string containing a <select name='$name' size='1'> form to 
 allow a user to select the domain to preform an operation in.  
@@ -1425,18 +1433,28 @@ See loncreateuser.pm for an example invo
 If the $includeempty flag is set, it also includes an empty choice ("no domain
 selected");
 
+If the $showdomdesc flag is set, the domain name is followed by the domain description. 
+
 =cut
 
 #-------------------------------------------
 sub select_dom_form {
-    my ($defdom,$name,$includeempty) = @_;
-    my @domains = sort(&Apache::lonnet::all_domains());
+    my ($defdom,$name,$includeempty,$showdomdesc) = @_;
+    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) {
         $selectdomain.="<option value=\"$dom\" ".
-            ($dom eq $defdom ? 'selected="selected" ' : '').
-                ">$dom</option>\n";
+            ($dom eq $defdom ? 'selected="selected" ' : '').'>'.$dom;
+        if ($showdomdesc) {
+            if ($dom ne '') {
+                my $domdesc = &Apache::lonnet::domain($dom,'description');
+                if ($domdesc ne '') {
+                    $selectdomain .= ' ('.$domdesc.')';
+                }
+            } 
+        }
+        $selectdomain .= "</option>\n";
     }
     $selectdomain.="</select>";
     return $selectdomain;
@@ -2154,6 +2172,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
@@ -2227,7 +2254,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');
 }
@@ -2457,7 +2485,6 @@ sub preferred_languages {
 		    split(/\s*(\,|\;|\:)\s*/,$env{'environment.languages'}));
     }
     my $browser=(split(/\;/,$ENV{'HTTP_ACCEPT_LANGUAGE'}))[0];
-    &Apache::lonnet::logthis($browser);
     if ($browser) {
 	@languages=(@languages,split(/\s*(\,|\;|\:)\s*/,$browser));
     }
@@ -3339,7 +3366,7 @@ sub designparm {
 
 =back
 
-=head1 HTTP Helpers
+=head1 HTML Helpers
 
 =over 4
 
@@ -3380,6 +3407,9 @@ Inputs:
 
 =item * $args, optional argument valid values are
             no_auto_mt_title -> prevents &mt()ing the title arg
+            inherit_jsmath -> when creating popup window in a page,
+                              should it have jsmath forced on by the
+                              current page
 
 =back
 
@@ -3436,7 +3466,7 @@ sub bodytag {
 
 # construct main body tag
     my $bodytag = "<body $extra_body_attr>".
-	&Apache::lontexconvert::init_math_support();
+	&Apache::lontexconvert::init_math_support($args->{'inherit_jsmath'});
 
     if ($bodyonly) {
         return $bodytag;
@@ -3633,20 +3663,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 {
@@ -3663,8 +3685,6 @@ sub endbodytag {
 
 =pod
 
-=over 4
-
 =item * &standard_css()
 
 Returns a style sheet
@@ -3675,8 +3695,6 @@ Inputs: (all optional)
             function       -> force usage of a specific rolish color scheme
             bgcolor        -> override the default page bgcolor
 
-=back
-
 =cut
 
 sub standard_css {
@@ -4438,7 +4456,7 @@ span.LC_nobreak {
 
 table.LC_docs_documents {
   background: #BBBBBB;
-  border-size: 0px;
+  border-width: 0px;
   border-collapse: collapse;
 }
 
@@ -4481,6 +4499,11 @@ table.LC_docs_documents td.LC_docs_docum
   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;
@@ -4503,8 +4526,6 @@ END
 
 =pod
 
-=over 4
-
 =item * &headtag()
 
 Returns a uniform footer for LON-CAPA web pages.
@@ -4528,8 +4549,6 @@ Inputs: $title - optional title for the
             no_auto_mt_title
                            -> prevent &mt()ing the title arg
 
-=back
-
 =cut
 
 sub headtag {
@@ -4585,16 +4604,12 @@ ADDMETA
 
 =pod
 
-=over 4
-
 =item * &font_settings()
 
 Returns neccessary <meta> to set the proper encoding
 
 Inputs: none
 
-=back
-
 =cut
 
 sub font_settings {
@@ -4611,16 +4626,12 @@ sub font_settings {
 
 =pod
 
-=over 4
-
 =item * &xml_begin()
 
 Returns the needed doctype and <html>
 
 Inputs: none
 
-=back
-
 =cut
 
 sub xml_begin {
@@ -4645,16 +4656,12 @@ sub xml_begin {
 
 =pod
 
-=over 4
-
 =item * &endheadtag()
 
 Returns a uniform </head> for LON-CAPA web pages.
 
 Inputs: none
 
-=back
-
 =cut
 
 sub endheadtag {
@@ -4663,8 +4670,6 @@ sub endheadtag {
 
 =pod
 
-=over 4
-
 =item * &head()
 
 Returns a uniform complete <head>..</head> section for LON-CAPA web pages.
@@ -4672,8 +4677,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 {
@@ -4683,8 +4686,6 @@ sub head {
 
 =pod
 
-=over 4
-
 =item * &start_page()
 
 Returns a complete <html> .. <body> section for LON-CAPA web pages.
@@ -4723,7 +4724,9 @@ Inputs: $title - optional title for the
 
                   no_auto_mt_title -> prevent &mt()ing the title arg
 
-=back
+                  inherit_jsmath -> when creating popup window in a page,
+                                    should it have jsmath forced on by the
+                                    current page
 
 =cut
 
@@ -4776,8 +4779,6 @@ sub start_page {
 
 =pod
 
-=over 4
-
 =item * &head()
 
 Returns a complete </body></html> section for LON-CAPA web pages.
@@ -4935,10 +4936,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.
@@ -5499,8 +5551,219 @@ sub get_secgrprole_info {
     return (\@sections,\@groups,$allroles,$rolehash,$accesshash);
 }
 
+sub user_picker {
+    my ($dom,$srch,$forcenewuser) = @_;
+    my $currdom = $dom;
+    my %curr_selected = (
+                        srchin => 'dom',
+                        srchby => 'uname',
+                      );
+    my $srchterm;
+    if (ref($srch) eq 'HASH') {
+        if ($srch->{'srchby'} ne '') {
+            $curr_selected{'srchby'} = $srch->{'srchby'};
+        }
+        if ($srch->{'srchin'} ne '') {
+            $curr_selected{'srchin'} = $srch->{'srchin'};
+        }
+        if ($srch->{'srchtype'} ne '') {
+            $curr_selected{'srchtype'} = $srch->{'srchtype'};
+        }
+        if ($srch->{'srchdomain'} ne '') {
+            $currdom = $srch->{'srchdomain'};
+        }
+        $srchterm = $srch->{'srchterm'};
+    }
+    my %lt=&Apache::lonlocal::texthash(
+                    'usr'       => 'Search criteria',
+                    'doma'      => 'Domain/institution to search',
+                    'uname'     => 'username',
+                    'lastname'  => 'last name',
+                    'lastfirst' => 'last name, first name',
+                    'crs'       => 'in this course',
+                    'dom'       => 'in this domain', 
+                    'alc'       => 'all LON-CAPA',
+                    'instd'     => 'in institutional directory',
+                    'exact'     => 'is',
+                    'contains'  => 'contains',
+                                       );
+    my $domform = &select_dom_form($currdom,'srchdomain',1,1);
+    my $srchinsel = ' <select name="srchin">';
+
+    my @srchins = ('crs','dom','alc','instd');
+
+    foreach my $option (@srchins) {
+        # FIXME 'alc' option unavailable until 
+        #       loncreateuser::print_user_query_page()
+        #       has been completed.
+        next if ($option eq 'alc');
+        next if ($option eq 'crs' && !$env{'request.course.id'});
+        if ($curr_selected{'srchin'} eq $option) {
+            $srchinsel .= ' 
+   <option value="'.$option.'" selected="selected">'.$lt{$option}.'</option>';
+        } else {
+            $srchinsel .= '
+   <option value="'.$option.'">'.$lt{$option}.'</option>';
+        }
+    }
+    $srchinsel .= "\n  </select>\n";
+
+    my $srchbysel =  ' <select name="srchby">';
+    foreach my $option ('uname','lastname','lastfirst') {
+        if ($curr_selected{'srchby'} eq $option) {
+            $srchbysel .= '
+   <option value="'.$option.'" selected="selected">'.$lt{$option}.'</option>';
+        } else {
+            $srchbysel .= '
+   <option value="'.$option.'">'.$lt{$option}.'</option>';
+         }
+    }
+    $srchbysel .= "\n  </select>\n";
+
+    my $srchtypesel = ' <select name="srchtype">';
+    foreach my $option ('exact','contains') {
+        if ($curr_selected{'srchtype'} eq $option) {
+            $srchtypesel .= '
+   <option value="'.$option.'" selected="selected">'.$lt{$option}.'</option>';
+        } else {
+            $srchtypesel .= '
+   <option value="'.$option.'">'.$lt{$option}.'</option>';
+        }
+    }
+    $srchtypesel .= "\n  </select>\n";
+
+    my ($newuserscript,$new_user_create);
+
+    if ($forcenewuser) {
+	$new_user_create = '<p> <input type="submit" name="forcenew" value="'.&HTML::Entities::encode(&mt('Make new user "[_1]"',$srchterm),'<>&"').'" onclick="javascript:setSearch(\'1\');" /> </p>';
+        $newuserscript = <<"ENDSCRIPT";
+
+function setSearch(createnew) {
+    if (createnew == 1) {
+        for (var i=0; i<document.crtuser.srchby.length; i++) {
+            if (document.crtuser.srchby.options[i].value == 'uname') {
+                document.crtuser.srchby.selectedIndex = i;
+            }
+        }
+        for (var i=0; i<document.crtuser.srchin.length; i++) {
+            if ( document.crtuser.srchin.options[i].value == 'dom') {
+		document.crtuser.srchin.selectedIndex = i;
+            }
+        }
+        for (var i=0; i<document.crtuser.srchtype.length; i++) {
+            if (document.crtuser.srchtype.options[i].value == 'exact') {
+                document.crtuser.srchtype.selectedIndex = i;
+            }
+        }
+        for (var i=0; i<document.crtuser.srchdomain.length; i++) {
+            if (document.crtuser.srchdomain.options[i].value == '$env{'request.role.domain'}') {
+                document.crtuser.srchdomain.selectedIndex = i;
+            }
+        }
+    }
+}
+ENDSCRIPT
+
+    }
+
+    my $output = <<"END_BLOCK";
+<script type="text/javascript">
+function validateEntry() {
+
+    var checkok = 1;
+    var srchin;
+    for (var i=0; i<document.crtuser.srchin.length; i++) {
+	if ( document.crtuser.srchin[i].checked ) {
+	    srchin = document.crtuser.srchin[i].value;
+	}
+    }
+
+    var srchtype = document.crtuser.srchtype.options[document.crtuser.srchtype.selectedIndex].value;
+    var srchby = document.crtuser.srchby.options[document.crtuser.srchby.selectedIndex].value;
+    var srchdomain = document.crtuser.srchdomain.options[document.crtuser.srchdomain.selectedIndex].value;
+    var srchterm =  document.crtuser.srchterm.value;
+    var srchin = document.crtuser.srchin.options[document.crtuser.srchin.selectedIndex].value;
+    var msg = "";
+
+    if (srchterm == "") {
+        checkok = 0;
+        msg += "You must include some text to search for.\\n";
+    }
+
+    if (srchtype== 'contains') {
+        if (srchterm.length < 3) {
+            checkok = 0;
+            msg += "The text you are searching for must contain at least three characters when using a 'contains' type search.\\n";
+        }
+    }
+    if (srchin == 'instd') {
+        if (srchdomain == '') {
+            checkok = 0;
+            msg += "You must choose a domain when using an institutional directory search.\\n";
+        }
+    }
+    if (srchin == 'dom') {
+        if (srchdomain == '') {
+            checkok = 0;
+            msg += "You must choose a domain when using a domain search.\\n";
+        }
+    }
+    if (srchby == 'lastfirst') {
+        if (srchterm.indexOf(",") == -1) {
+            checkok = 0;
+            msg += "When using searching by last,first you must include a comma as separator between last name and first name.\\n";
+        }
+        if (srchterm.indexOf(",") == srchterm.length -1) {
+            checkok = 0;
+            msg += "When searching by last,first you must include at least one character in the first name.\\n";
+        }
+    }
+    if (checkok == 0) {
+        alert("The following need to be corrected before the search can be run:\\n"+msg);
+        return;
+    }
+    if (checkok == 1) {
+        document.crtuser.submit();
+    }
+}
+
+$newuserscript
+
+</script>
+
+$new_user_create
+
+<table>
+ <tr>
+  <td>$lt{'usr'}:</td>
+  <td>$srchbysel
+      $srchtypesel 
+      <input type="text" size="15" name="srchterm" value="$srchterm" />
+      &nbsp;&nbsp;$srchinsel 
+  </td>
+ </tr>
+ <tr>
+  <td align="right">$lt{'doma'}:</td>
+  <td>$domform</td>
+  </td>
+ </tr>
+</table>
+<br />
+END_BLOCK
+
+    return $output;
+}
+
+
+
 =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
@@ -5750,28 +6013,50 @@ sub record_sep {
             $i++;
         }
     } else {
-        my @allfields;
+        my $separator=',';
         if ($env{'form.upfiletype'} eq 'semisv') {
-            @allfields=split(/;/,$record,-1);
-        } else {
-            @allfields=split(/\,/,$record,-1);
+            $separator=';';
         }
         my $i=0;
-        my $j;
-        for ($j=0;$j<=$#allfields;$j++) {
-            my $field=$allfields[$j];
-            if ($field=~/^\s*(\"|\')/) {
-		my $delimiter=$1;
-                while (($field!~/$delimiter$/) && ($j<$#allfields)) {
-		    $j++;
-		    $field.=','.$allfields[$j];
-		}
-                $field=~s/^\s*$delimiter//;
-                $field=~s/$delimiter\s*$//;
-            }
-            $components{&takeleft($i)}=$field;
-	    $i++;
+# the character we are looking for to indicate the end of a quote or a record 
+        my $looking_for=$separator;
+# do not add the characters to the fields
+        my $ignore=0;
+# we just encountered a separator (or the beginning of the record)
+        my $just_found_separator=1;
+# store the field we are working on here
+        my $field='';
+# work our way through all characters in record
+        foreach my $character ($record=~/(.)/g) {
+            if ($character eq $looking_for) {
+               if ($character ne $separator) {
+# Found the end of a quote, again looking for separator
+                  $looking_for=$separator;
+                  $ignore=1;
+               } else {
+# Found a separator, store away what we got
+                  $components{&takeleft($i)}=$field;
+	          $i++;
+                  $just_found_separator=1;
+                  $ignore=0;
+                  $field='';
+               }
+               next;
+            }
+# single or double quotation marks after a separator indicate beginning of a quote
+# we are now looking for the end of the quote and need to ignore separators
+            if ((($character eq '"') || ($character eq "'")) && ($just_found_separator))  {
+               $looking_for=$character;
+               next;
+            }
+# ignore would be true after we reached the end of a quote
+            if ($ignore) { next; }
+            if (($just_found_separator) && ($character=~/\s/)) { next; }
+            $field.=$character;
+            $just_found_separator=0; 
         }
+# catch the very last entry, since we never encountered the separator
+        $components{&takeleft($i)}=$field;
     }
     return %components;
 }