--- loncom/interface/lonsearchcat.pm 2016/11/09 19:37:39 1.331.4.13 +++ loncom/interface/lonsearchcat.pm 2025/03/19 15:44:44 1.364 @@ -1,7 +1,7 @@ # The LearningOnline Network with CAPA # Search Catalog # -# $Id: lonsearchcat.pm,v 1.331.4.13 2016/11/09 19:37:39 raeburn Exp $ +# $Id: lonsearchcat.pm,v 1.364 2025/03/19 15:44:44 raeburn Exp $ # # Copyright Michigan State University Board of Trustees # @@ -170,22 +170,46 @@ sub handler { ## &Apache::lonhtmlcommon::clear_breadcrumbs(); - my @allowed_searches = ('portfolio'); + my $crumb_text; + my @allowed_searches; + if ($env{'form.catalogmode'} eq 'import') { + $env{'form.area'} = 'res'; + $crumb_text = 'Content Library Search'; + } else { + push(@allowed_searches,'portfolio'); + } if (&Apache::lonnet::allowed('bre',$env{'request.role.domain'}) eq 'F') { push(@allowed_searches,'res'); - } - my $crumb_text = 'Portfolio Search'; + } else { + unless ($env{'form.catalogmode'} eq 'import') { + $env{'form.area'} = 'portfolio'; + $crumb_text = 'Portfolio Search'; + } + } if (@allowed_searches ==2) { - $crumb_text = 'Portfolio and Catalog Search'; + unless (($env{'form.area'} eq 'portfolio') || ($env{'form.area'} eq 'res')) { + delete($env{'form.area'}); + } + $crumb_text = 'Portfolio and Content Library 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(). '&catalogmode='.$env{'form.catalogmode'}. '&launch='.$env{'form.launch'}. - '&mode='.$env{'form.mode'}, + '&mode='.$env{'form.mode'}. + '&area='.$env{'form.area'}, text=>"$crumb_text", - target=>'_top', + target=>$target, bug=>'Searching',}); # if ($env{'form.phase'} !~ m/(basic|adv|course)_search/) { @@ -299,7 +323,7 @@ END } # if ($env{'form.searchmode'} eq 'advanced') { - my $srchtype = 'Catalog'; + my $srchtype = 'Content Library'; if ($env{'form.area'} eq 'portfolio') { $srchtype = 'Portfolio'; } @@ -308,10 +332,23 @@ END '&phase=disp_adv'. '&catalogmode='.$env{'form.catalogmode'}. '&launch='.$env{'form.launch'}. - '&mode='.$env{'form.mode'}, + '&mode='.$env{'form.mode'}. + '&area='.$env{'form.area'}, text=>"Advanced $srchtype Search", bug=>'Searching',}); - } + } elsif (($env{'form.phase'} eq 'results') || + ($env{'form.phase'} =~ /^(sort|run_search)$/)) { + &Apache::lonhtmlcommon::add_breadcrumb + ({href=>'/adm/searchcat?'.&Apache::loncommon::inhibit_menu_check(). + '&phase=disp_adv'. + '&catalogmode='.$env{'form.catalogmode'}. + '&launch='.$env{'form.launch'}. + '&mode='.$env{'form.mode'}. + '&area='.$env{'form.area'}. + '&searchmode='.$env{'form.searchmode'}, + text=>"Search Results", + bug=>'Searching',}); + } ## ## Switch on the phase ## @@ -328,10 +365,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')) { @@ -390,7 +427,7 @@ END } } return OK; -} +} # # The mechanism used to store values away and retrieve them does not @@ -428,12 +465,48 @@ sub hidden_field { return ''.$/; } +sub start_search_tabs { + my $area; + my %lt = &Apache::lonlocal::texthash ( + res => 'Content Library Search', + portfolio => 'Portfolio Search', + ); + my $output = ''; + } + } else { + $area = 'portfolio'; + $output .= "\n".'
  • '. + '    '.$lt{'portfolio'}. + '    
  • '; + } + $output .= '
    '. + '
    '. + '
    '; + return $output; +} + +sub end_search_tabs { + return '
    '; +} + ###################################################################### =pod =over 4 - + =item &print_basic_search_form() Prints the form for the basic search. Sorry the name is so cryptic. @@ -444,19 +517,31 @@ Prints the form for the basic search. S ###################################################################### sub print_basic_search_form { my ($r,$closebutton,$hidden_fields) = @_; + my %lt = &Apache::lonlocal::texthash ( + res => 'Content Library Search', + portfolio => 'Portfolio Search', + ); my $result = ($env{'form.catalogmode'} ne 'import'); + my $area; my $bread_crumb = &Apache::lonhtmlcommon::breadcrumbs('Searching','Search_Basic', $env{'form.catalogmode'} ne 'import'); - my $scrout = &Apache::loncommon::start_page('Content Library').$bread_crumb; -# Search form for resource space + my $scrout = &Apache::loncommon::start_page('Content Library').$bread_crumb. + '
    '."\n". + &start_search_tabs(); if (&Apache::lonnet::allowed('bre',$env{'request.role.domain'}) eq 'F') { - $scrout .= &setup_basic_search($r,'res',$hidden_fields,$closebutton); - $scrout .= '

    '; - } + if ($env{'form.area'} eq 'portfolio') { # Search form for accessible portfolio files - $scrout.= &setup_basic_search($r,'portfolio',$hidden_fields,$closebutton); - $scrout .= &Apache::loncommon::end_page(); + $scrout .= &setup_basic_search($r,'portfolio',$hidden_fields,$closebutton); + } else { +# Search form for resource space + $scrout .= &setup_basic_search($r,'res',$hidden_fields,$closebutton); + } + } else { +# Search form for accessible portfolio files + $scrout .= &setup_basic_search($r,'portfolio',$hidden_fields,$closebutton); + } + $scrout .= &end_search_tabs().&Apache::loncommon::end_page(); $r->print($scrout); return; } @@ -465,7 +550,7 @@ sub setup_basic_search { my ($r,$area,$hidden_fields,$closebutton) = @_; # Define interface components my %lt = &Apache::lonlocal::texthash ( - res => 'LON-CAPA Catalog Search', + res => 'Content Library Search', portfolio => 'Portfolio Search', ); my ($userelatedwords,$onlysearchdomain,$inclext,$adv_search_link,$scrout); @@ -495,7 +580,7 @@ sub setup_basic_search { } else { $singledom = $env{'user.domain'}; $disabled = ' disabled="disabled"'; - $checked = 1; + $checked = 1; } $onlysearchdomain = ''; my $countselect = &Apache::lonmeta::selectbox('show', - $env{'form.show'}, + $env{'form.show'},'','', undef, (10,20,50,100,1000,10000)); - $scrout .= ' ' + $scrout .= ' '.$/; + .''.$/; return $scrout; } @@ -1251,8 +1369,10 @@ sub parse_advanced_search { } if (! $fillflag) { &output_blank_field_error($r,$closebutton, - 'phase=disp_adv',$hidden_fields); - return ; + 'phase=disp_adv&area='.$env{'form.area'}. + '&catalogmode='.$env{'form.catalogmode'}, + $hidden_fields); + return; } # Turn the form input into a SQL-based query my $query=''; @@ -1265,7 +1385,9 @@ sub parse_advanced_search { &process_phrase_input($env{'form.'.$field}, $env{'form.'.$field.'_related'},$field); if (defined($error)) { - &output_unparsed_phrase_error($r,$closebutton,'phase=disp_adv', + &output_unparsed_phrase_error($r,$closebutton, + 'phase=disp_adv&area='.$env{'form.area'}. + '&catalogmode='.$env{'form.catalogmode'}. $hidden_fields,$field); return; } else { @@ -1549,7 +1671,9 @@ sub parse_basic_search { # Check to see if enough of a query is filled in my $search_string = $env{'form.basicexp'}; if (! &filled($search_string)) { - &output_blank_field_error($r,$closebutton,'phase=disp_basic'); + &output_blank_field_error($r,$closebutton,'phase=disp_basic'. + '&area='.$env{'form.area'}. + '&catalogmode='.$env{'form.catalogmode'}); return OK; } my $pretty_search_string=$search_string; @@ -1565,7 +1689,9 @@ sub parse_basic_search { $env{'form.related'}, $searchfield); if ($error) { - &output_unparsed_phrase_error($r,$closebutton,'phase=disp_basic', + &output_unparsed_phrase_error($r,$closebutton,'phase=disp_basic'. + '&area='.$env{'form.area'}. + '&catalogmode='.$env{'form.catalogmode'}, '','basicexp'); return; } @@ -1881,6 +2007,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."'". @@ -1899,6 +2027,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."'". @@ -2048,7 +2178,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( @@ -2081,29 +2211,20 @@ sub print_sort_form { &Apache::lonnet::logthis(&Apache::lonmysql::get_error()); return; } - my $js =< -// $target}; } -// ]]> - -END - - my $start_page = &Apache::loncommon::start_page('Results'); + 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 @@ -2125,7 +2246,7 @@ END .' '.$revise.'

    ' .'

    '.&mt('Search: ').$pretty_query_string .'

    '; - $r->print($result.&Apache::loncommon::end_page()); + $r->print($result.'
    '.&Apache::loncommon::end_page()); return; } @@ -2262,7 +2383,8 @@ SCRIPT sub reload_result_frame { my ($r) = @_; my $newloc = '/adm/searchcat?phase=results&persistent_db_id='. - $env{'form.persistent_db_id'}; + $env{'form.persistent_db_id'}.'&area='.$env{'form.area'}. + '&catalogmode='.$env{'form.catalogmode'}; $r->print(< parent.update_results("$newloc"); @@ -2332,7 +2454,9 @@ sub revise_button { my $newloc = '/adm/searchcat'. '?persistent_db_id='.$env{'form.persistent_db_id'}. '&cleargroupsort=1'. - '&phase='.$revise_phase; + '&phase='.$revise_phase. + '&area='.$env{'form.area'}. + '&catalogmode='.$env{'form.catalogmode'}; my $result = qq{ }; return $result; @@ -2354,7 +2478,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'; @@ -2363,13 +2487,19 @@ 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 # Remove leading and trailing
    $pretty_string =~ s:^\s*
    ::i; @@ -2414,8 +2544,6 @@ END %all_library_servers = (%library_servers,%older_library_servers); @Servers_to_contact = sort(keys(%all_library_servers)); foreach my $server (@Servers_to_contact) { - my %possdoms; - map { $possdoms{$_}=1; } &Apache::lonnet::machine_domains($all_library_servers{$server}); $domains_by_server{$server} = join(',',sort(&Apache::lonnet::machine_domains($all_library_servers{$server}))); } @@ -2455,6 +2583,7 @@ END ## Prepare for the big loop. my $hitcountsum; my $oldhitcountsum; + my $displaycount; my %matches; my $server; my $status; @@ -2501,7 +2630,7 @@ END &update_status($r, &mt('waiting on [_1]',join(' ',keys(%Server_status)))); } - sleep(0.1); + sleep(0.1); } # # Loop through the servers we have contacted but do not @@ -2554,8 +2683,8 @@ END if ($area eq 'portfolio') { next if (defined($matches{$Fields{'url'}})); - # Skip if inaccessible - next if (!&Apache::lonnet::portfolio_access($Fields{'url'})); + # Skip unless access control set to public or passphrase-protected + next unless (($Fields{'scope'} eq 'public') || ($Fields{'scope'} eq 'guest')); $matches{$Fields{'url'}} = 1; } # @@ -2579,8 +2708,10 @@ END last if ($connection->aborted()); if ($oldhitcountsum < $hitcountsum) { &update_count_status($r,$hitcountsum); - if ($hitcountsum <= $env{'form.show'}) { + if (($hitcountsum <= $env{'form.show'}) || + (!$displaycount && $hitcountsum)) { reload_result_frame($r); + $displaycount = $hitcountsum; } $oldhitcountsum = $hitcountsum; } @@ -2596,11 +2727,11 @@ END # We have run out of time or run out of servers to talk to and # results to get, so let the client know the top frame needs to be # loaded from /adm/searchcat - $r->print(&Apache::loncommon::end_page()); + $r->print('
    '.&Apache::loncommon::end_page()); # if ($env{'form.catalogmode'} ne 'import') { $r->print(< -window.location='/adm/searchcat?phase=sort&persistent_db_id=$env{'form.persistent_db_id'}'; +window.location='/adm/searchcat?phase=sort&area=$env{"form.area"}&catalogmode=$env{"form.catalogmode"}&persistent_db_id=$env{"form.persistent_db_id"}'; SCRIPT # } @@ -2660,7 +2791,8 @@ sub display_results { if (!defined($viewfunction)) { $r->print('

    ' .&mt('Internal Error - Bad view selected.') - .'

    '."\n"); + .'

    '."\n" + .''.&Apache::loncommon::end_page()); $r->rflush(); return; } @@ -2671,7 +2803,8 @@ sub display_results { ## ## Get the catalog controls setup ## - my $action = "/adm/searchcat?phase=results"; + my $action = '/adm/searchcat?phase=results&area='.$env{'form.area'}. + '&catalogmode='.$env{'form.catalogmode'}; ## ## Deal with import by opening the import db file. if ($env{'form.catalogmode'} eq 'import') { @@ -2682,15 +2815,15 @@ sub display_results { $r->print('

    '. &mt('Unable to save import 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 @@ -2703,7 +2836,7 @@ sub display_results { $r->print('

    '. &mt('A MySQL error has occurred.'). '

    '. - ''. + ''. &Apache::loncommon::end_page()); &Apache::lonnet::logthis("lonmysql was unable to determine the number". " of rows in table ".$table); @@ -2808,17 +2941,18 @@ sub display_results { $env{'form.sortorder'}='asc'; } } - my $sortform = '' - .&mt('Sort by:').' ' + my $sortform = '' + .&mt('Sort by:').' ' .&Apache::loncommon::select_form($env{'form.sortfield'}, - 'sortfield', - \%sort_fields) + 'sortfield', + \%sort_fields,'','','', + 'LC_sortby') .' ' .&Apache::loncommon::select_form($env{'form.sortorder'}, - 'sortorder', - {asc =>&mt('Ascending'), - desc=>&mt('Descending') - }) + 'sortorder', + {asc =>&mt('Ascending'), + desc=>&mt('Descending') + },'','','','LC_sortby') .''; ## ## Display links for 'prev' and 'next' pages (if necessary) and Display Options @@ -2832,15 +2966,15 @@ sub display_results { ); if ($total_results == 0) { - $r->print('

    '.&mt('There are currently no results.').'

    '. - "". + $r->print('

    '.&mt('There are currently no results.').'

    '. + ''. &Apache::loncommon::end_page()); return; } else { - $r->print('
    '. + $r->print('

    '. mt('Results [_1] to [_2] out of [_3]', $min,$max,$total_results). - "

    \n"); + "\n"); } ## ## Get results from MySQL table @@ -2870,7 +3004,14 @@ sub display_results { if ($area eq 'portfolio') { $tabletype = 'portfolio_search'; } - $r->print(&Apache::loncommon::start_data_table()); + $r->print(&Apache::loncommon::start_data_table(). + &Apache::loncommon::start_data_table_header_row(). + ''.&mt('Data').''); + if (($env{'form.viewselect'} eq 'detailedpreview') || + ($env{'form.viewselect'} eq 'summarypreview')) { + $r->print(''.&mt('Preview').''); + } + $r->print(&Apache::loncommon::end_data_table_header_row()); foreach my $row (@Results) { if ($connection->aborted()) { &cleanup(); @@ -2908,7 +3049,7 @@ sub display_results { $env{'form.persistent_db_id'}) ); } - $r->print("".&Apache::loncommon::end_page()); + $r->print(''.&Apache::loncommon::end_page()); $r->rflush(); untie %groupsearch_db if (tied(%groupsearch_db)); return; @@ -3219,6 +3360,7 @@ SCRIPT 'add_modal' =>1}); my $result=<
    $importbutton END @@ -3227,6 +3369,8 @@ END sub results_link { my $basic_link = "/adm/searchcat?"."&table=".$env{'form.table'}. + "&area=".$env{'form.area'}. + "&catalogmode=".$env{'form.catalogmode'}. "&persistent_db_id=".$env{'form.persistent_db_id'}; my $results_link = $basic_link."&phase=results". "&pause=1"."&start=1"; @@ -3237,7 +3381,9 @@ sub results_link { ###################################################################### sub print_frames_interface { my $r = shift; - my $basic_link = "/adm/searchcat?"."&table=".$env{'form.table'}. + my $basic_link = "/adm/searchcat?table=".$env{'form.table'}. + "&area=".$env{'form.area'}. + "&catalogmode=".$env{'form.catalogmode'}. "&persistent_db_id=".$env{'form.persistent_db_id'}; my $run_search_link = $basic_link."&phase=run_search"; my $results_link = &results_link(); @@ -3577,18 +3723,13 @@ sub display_url { # (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;\""; + 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,$onclick).' '; - # 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) - $link =~ s/(href="[^"]*")/\1 onclick="window.open(this.href, '_blank', 'toolbar=1,location=1,menubar=0');return false;"/g; } return $link; }