--- loncom/interface/lonsearchcat.pm	2014/02/23 22:16:20	1.331.4.10
+++ loncom/interface/lonsearchcat.pm	2022/05/29 21:59:55	1.331.4.16.2.1
@@ -1,7 +1,7 @@
 # The LearningOnline Network with CAPA
 # Search Catalog
 #
-# $Id: lonsearchcat.pm,v 1.331.4.10 2014/02/23 22:16:20 raeburn Exp $
+# $Id: lonsearchcat.pm,v 1.331.4.16.2.1 2022/05/29 21:59:55 raeburn Exp $
 #
 # Copyright Michigan State University Board of Trustees
 #
@@ -78,6 +78,7 @@ use Apache::lonnavmaps;
 use Apache::lonindexer();
 use Apache::lonwishlist();
 use LONCAPA;
+use Time::HiRes qw(sleep);
 
 ######################################################################
 ######################################################################
@@ -143,7 +144,7 @@ sub handler {
     ##     this once, so the pause indicator is deleted
     ##
     if (exists($env{'form.pause'})) {
-        sleep(1);
+        sleep(0.1);
         delete($env{'form.pause'});
     }
     ##
@@ -177,6 +178,15 @@ sub handler {
     if (@allowed_searches ==2) {
        $crumb_text = 'Portfolio and Catalog Search'; 
     }
+    my $target = '_top';
+    if ((($env{'request.lti.login'}) && ($env{'request.lti.target'} eq 'iframe')) ||
+        (($env{'request.deeplink.login'}) && ($env{'request.deeplink.target'} eq '_self'))) {
+        if ($env{'form.phase'} =~ /^(sort|run_search)$/) {
+            $target = '_parent';
+        } else {
+            $target = '_self';
+        }
+    }
     &Apache::lonhtmlcommon::add_breadcrumb
        ({href=>'/adm/searchcat?'.
 	       &Apache::loncommon::inhibit_menu_check().
@@ -184,7 +194,7 @@ sub handler {
                '&launch='.$env{'form.launch'}.
                '&mode='.$env{'form.mode'},
               text=>"$crumb_text",
-              target=>'_top',
+              target=>$target,
               bug=>'Searching',});
     #
     if ($env{'form.phase'} !~ m/(basic|adv|course)_search/) {
@@ -327,10 +337,10 @@ END
                  ['query','customquery','customshow',
                   'libraries','pretty_string','domains']);
         if ($env{'form.phase'} eq 'sort') {
-            &print_sort_form($r,$pretty_string);
+            &print_sort_form($r,$pretty_string,$target);
         } elsif ($env{'form.phase'} eq 'run_search') {
             &run_search($r,$query,$customquery,$customshow,
-                        $libraries,$pretty_string,$env{'form.area'},$domainsref);
+                        $libraries,$pretty_string,$env{'form.area'},$domainsref,$target);
         }
     } elsif(($env{'form.phase'} eq 'basic_search') ||
             ($env{'form.phase'} eq 'adv_search')) {
@@ -478,14 +488,31 @@ sub setup_basic_search {
                      .&mt('use related words')
                      .'</label>';
 
+    my $anydom = 1;
+    if ($area eq 'res') {
+        unless (&Apache::lonnet::allowed('bre','/res/') eq 'F') {
+            $anydom = 0;
+        }
+    }
+    my $singledom;
+    my ($disabled,$checked);
+    if ($anydom) {
+       $singledom = $r->dir_config('lonDefDomain');
+       if ($env{'form.domains'} eq $singledom) {
+           $checked = 1;
+       }
+    } else {
+       $singledom = $env{'user.domain'};
+       $disabled = ' disabled="disabled"';
+       $checked = 1;
+    }
     $onlysearchdomain = '<label>'
                        .&Apache::lonhtmlcommon::checkbox(
-                           'domains',
-                           $env{'form.domains'},
-                           $r->dir_config('lonDefDomain'))
+                           'domains',$checked,
+                           $singledom,$disabled)
                        .' '
                        .&mt('only search domain [_1]'
-                               ,'<b>'.$r->dir_config('lonDefDomain').'</b>')
+                               ,'<b>'.$singledom.'</b>')
                        .'</label>';
 
     $adv_search_link = '<a href="/adm/searchcat?'.
@@ -660,10 +687,22 @@ function additional_metadata() {
                    $env{'form.category'})
               .&Apache::lonhtmlcommon::row_closure();
 
-    $scrout .= &Apache::lonhtmlcommon::row_title(&titlefield(&mt('Domains')))
-              .&Apache::loncommon::domain_select('domains',
-                   $env{'form.domains'},1)
-              .&Apache::lonhtmlcommon::row_closure();
+    my $anydomain = 1;
+    if ($env{'form.area'} ne 'portfolio') {
+        unless (&Apache::lonnet::allowed('bre','/res/')) {
+            $anydomain = 0;
+        }
+    }
+
+    $scrout .= &Apache::lonhtmlcommon::row_title(&titlefield(&mt('Domains')));
+    if ($anydomain) {
+        $scrout .= &Apache::loncommon::domain_select('domains',
+                   $env{'form.domains'},1);
+    } else {
+        $scrout .= &Apache::loncommon::select_dom_form($env{'user.domain'},
+                                                       'domains','','','',[$env{'user.domain'}],'',1);
+    }
+    $scrout .= &Apache::lonhtmlcommon::row_closure();
 
     # Misc metadata
     if ($env{'form.area'} ne 'portfolio') {
@@ -1851,6 +1890,8 @@ sub build_date_queries {
             my (undef,undef,undef,$cbday,$cbmon,$cbyear) = localtime($cbefore);
             # Correct for year being relative to 1900
             $cayear+=1900; $cbyear+=1900;
+            # Correct month; localtime gives month 0..11 but MySQL expects 1..12
+            $camon++; $cbmon++;
             my $cquery=
                 '(creationdate BETWEEN '.
                 "'".$cayear.'-'.$camon.'-'.$caday."'".
@@ -1869,6 +1910,8 @@ sub build_date_queries {
             my (undef,undef,undef,$mbday,$mbmon,$mbyear) = localtime($mbefore);
             # Correct for year being relative to 1900
             $mayear+=1900; $mbyear+=1900;
+            # Correct month; localtime gives month 0..11 but MySQL expects 1..12
+            $mamon++; $mbmon++;
             my $mquery=
                 '(lastrevisiondate BETWEEN '.
                 "'".$mayear.'-'.$mamon.'-'.$maday."'".
@@ -1911,10 +1954,11 @@ sub copyright_check {
     my (undef,undef,$resdom,$resname) = split('/',
                                               $Metadata->{'url'});
     # Check for priv
-    if (($Metadata->{'copyright'} eq 'priv') && 
-        (($env{'user.name'} ne $resname) &&
-         ($env{'user.domain'} ne $resdom))) {
-        return 0;
+    if ($Metadata->{'copyright'} eq 'priv') {
+        unless (($env{'user.name'} eq $resname) &&
+                ($env{'user.domain'} eq $resdom)) {
+            return 0;
+        }
     }
     # Check for domain
     if (($Metadata->{'copyright'} eq 'domain') &&
@@ -2017,7 +2061,7 @@ a link to change the search query.
 ######################################################################
 ######################################################################
 sub print_sort_form {
-    my ($r,$pretty_query_string) = @_;
+    my ($r,$pretty_query_string,$target) = @_;
 
     ##
     my %SortableFields=&Apache::lonlocal::texthash( 
@@ -2064,15 +2108,20 @@ sub print_sort_form {
 </script>
 END
 
-    my $start_page = &Apache::loncommon::start_page('Results',$js);
+    my $args;
+    if ($target eq '_parent') {
+        $args = {'links_target' => $target};
+    }
+    my $start_page = &Apache::loncommon::start_page('Results',undef,$args);
     my $breadcrumbs=
         &Apache::lonhtmlcommon::breadcrumbs('Searching','Searching',
-					    $env{'form.catalogmode'} ne 'import');
+					    $env{'form.catalogmode'} ne 'import',
+                                            '','','','','','',$target);
 
     my $result = <<END;
 $start_page
 $breadcrumbs
-<form name="statusform" action="" method="post" target="_top">
+<form name="statusform" action="" method="post" target="$target">
 <input type="hidden" name="catalogmode" value="import" />
 <input type="hidden" name="acts" value="" />
 END
@@ -2228,8 +2277,21 @@ SCRIPT
     $r->rflush();
 }
 
+sub reload_result_frame {
+    my ($r) = @_;
+    my $newloc = '/adm/searchcat?phase=results&persistent_db_id='.
+        $env{'form.persistent_db_id'};
+    $r->print(<<SCRIPT);
+<script type="text/javascript">
+    parent.update_results("$newloc");
+</script>
+SCRIPT
+
+    $r->rflush();
+}
+
 {
-    my $max_time  = 300;  # seconds for the search to complete
+    my $max_time  = 60;  # seconds for the search to complete
     my $start_time = 0;
     my $last_time = 0;
 
@@ -2310,7 +2372,7 @@ results into MySQL.
 ######################################################################
 sub run_search {
     my ($r,$query,$customquery,$customshow,$serverlist,
-        $pretty_string,$area,$domainsref) = @_;
+        $pretty_string,$area,$domainsref,$target) = @_;
     my $tabletype = 'metadata';
     if ($area eq 'portfolio') {
         $tabletype = 'portfolio_search';
@@ -2319,10 +2381,15 @@ sub run_search {
     #
     # Print run_search header
     #
-    my $start_page = &Apache::loncommon::start_page('Search Status',undef);
+    my $args;
+    if ($target eq '_parent') {
+        $args = {'links_target' => $target};
+    }
+    my $start_page = &Apache::loncommon::start_page('Search Status',undef,$args);
     my $breadcrumbs =
 	&Apache::lonhtmlcommon::breadcrumbs('Searching','Searching',
-					    $env{'form.catalogmode'} ne 'import');
+					    $env{'form.catalogmode'} ne 'import',
+                                            '','','','','','',$target);
     $r->print(<<END);
 $start_page
 $breadcrumbs
@@ -2410,6 +2477,8 @@ END
     ##
     ## Prepare for the big loop.
     my $hitcountsum;
+    my $oldhitcountsum;
+    my $displaycount;
     my %matches;
     my $server; 
     my $status;
@@ -2456,7 +2525,7 @@ END
                 &update_status($r,
                        &mt('waiting on [_1]',join(' ',keys(%Server_status))));
             }
-            sleep(1); 
+            sleep(0.1); 
         }
         #
         # Loop through the servers we have contacted but do not
@@ -2532,7 +2601,15 @@ END
                 delete($Server_status{$server});
             }
             last if ($connection->aborted());
-            &update_count_status($r,$hitcountsum);
+            if ($oldhitcountsum < $hitcountsum) {
+                &update_count_status($r,$hitcountsum);
+                if (($hitcountsum <= $env{'form.show'}) ||
+                    (!$displaycount && $hitcountsum)) {
+                    reload_result_frame($r);
+                    $displaycount = $hitcountsum;
+                }
+                $oldhitcountsum = $hitcountsum;
+            }
         }
         last if ($connection->aborted());
         &update_seconds($r);
@@ -2626,6 +2703,8 @@ sub display_results {
     if ($env{'form.catalogmode'} eq 'import') {
         if (! tie(%groupsearch_db,'GDBM_File',$diropendb,
                   &GDBM_WRCREAT(),0640)) {
+            # NOTE: this can happen when a previous request to searchcat?phase=results gets interrupted
+            # (%groupsearch_db is not untied)
             $r->print('<p class="LC_error">'.
               &mt('Unable to save import results.').
               '</p>'.
@@ -2633,7 +2712,11 @@ sub display_results {
 		      &Apache::loncommon::end_page());
             $r->rflush();
             return;
-        } 
+        }
+        # untie %groupsearch_db if the connection gets aborted before the end
+        $r->register_cleanup(sub {
+            untie %groupsearch_db if (tied(%groupsearch_db));
+        }); 
     }
     ##
     ## Prepare the table for querying
@@ -2775,8 +2858,7 @@ sub display_results {
     );
 
     if ($total_results == 0) {
-        $r->print('<meta HTTP-EQUIV="Refresh" CONTENT="2" />'.
-                  '<p class="LC_info">'.&mt('There are currently no results.').'</p>'.
+        $r->print('<p class="LC_info">'.&mt('There are currently no results.').'</p>'.
                   "</form>".
 		  &Apache::loncommon::end_page());
         return;
@@ -3149,6 +3231,14 @@ SCRIPT
 </script>
 SCRIPT
 
+    $js.=<<SCRIPT;
+<script type="text/javascript">
+    \$(document).ready(function() {
+        parent.done_loading_results();
+    });
+</script>
+SCRIPT
+
     my $start_page  = &Apache::loncommon::start_page(undef,$js,
 						     {'only_body' =>1,
                                                       'add_wishlist' =>1,
@@ -3182,6 +3272,26 @@ sub print_frames_interface {
 // <![CDATA[
 var targetwin = opener;
 var queue = '';
+
+var loading_results = true;
+var need_reloading = false;
+var new_location;
+function update_results(newloc) {
+    if (loading_results) {
+        need_reloading = true;
+        new_location = newloc;
+    } else {
+        loading_results = true;
+        resultsframe.location = newloc;
+    }
+}
+function done_loading_results() {
+    loading_results = false;
+    if (need_reloading) {
+        need_reloading = false;
+        update_results(new_location);
+    }
+}
 // ]]>
 </script>
 JS
@@ -3294,7 +3404,7 @@ sub detailed_citation_view {
         '<b>'.$prefix.
         '<img src="'.&Apache::loncommon::icon($values{'url'}).'" alt="" />'.'&nbsp;'.
         '<a href="'.$jumpurl.'?inhibitmenu=yes" '.
-        'target="preview">'.$values{'title'}."</a></b>\n".
+        'target="preview" onclick="openMyModal(this.href, 500, 500, \'yes\');return false;">'.$values{'title'}."</a></b>\n".
         &display_tools($values{'title'}, $jumpurl).
         "<p>\n".
         '<b>'.$values{'author'}.'</b>,'.
@@ -3427,7 +3537,7 @@ sub summary_view {
     my $link = '<br />'.&display_url($jumpurl,1).'<br />';
     $result .=
         '<a href="'.$jumpurl.'?inhibitmenu=yes"'.
-        ' target="preview">'.$values{'title'}.'</a>'.
+        ' target="preview" onclick="openMyModal(this.href, 500, 500, \'yes\');return false;">'.$values{'title'}.'</a>'.
         &display_tools($values{'title'}, $jumpurl).<<END;
 <br />
 $link<br />
@@ -3473,7 +3583,7 @@ sub compact_view {
     }
     $jumpurl = &HTML::Entities::encode($jumpurl,'<>&"');
     $result.=' <span class="LC_nobreak">'.
-	'<a href="'.$jumpurl.'?inhibitmenu=yes" target="preview">'.
+	'<a href="'.$jumpurl.'?inhibitmenu=yes" target="preview" onclick="openMyModal(this.href, 500, 500, \'yes\');return false;">'.
         &HTML::Entities::encode($values{'title'},'<>&"').'</a></span> '.
         &display_tools($values{'title'}, $jumpurl).
 	$link.' <b>'.$values{'author'}.'</b> ('.$values{'domain'}.')';
@@ -3489,12 +3599,17 @@ sub display_url {
     } elsif ($url=~m{^(http://|/uploaded/)}) {
 	$link='<span class="LC_filename">'.$url.'</span>';
     } else {
+        # replace the links to open in a new window
+        # (because the search opens in a new window, it gets
+        # confusing when the links open a tab in the
+        # parent window; ideally we should not force windows)
+        my $onclick = " onclick=\"window.open(this.href, '_blank', 'toolbar=1,location=1,menubar=0');return false;\"";
         $link=&Apache::lonhtmlcommon::crumbs(
                   $url,
                   'preview',
                   '',
-                  (($env{'form.catalogmode'} eq 'import')?'parent.statusframe.document.forms.statusform':''),
-                  $skiplast).' ';
+                  '',
+                  $skiplast,$onclick).' ';
     }
     return $link;
 }
@@ -3800,7 +3915,7 @@ Cleans the global %groupsearch_db by rem
 ######################################################################
 sub start_fresh_session {
     delete $groupsearch_db{'mode_catalog'};
-    foreach (keys %groupsearch_db) {
+    foreach (keys(%groupsearch_db)) {
         if ($_ =~ /^pre_/) {
             delete $groupsearch_db{$_};
         }