loncom/interface/lonsearchcat.pm - view

File: [LON-CAPA] / loncom / interface / lonsearchcat.pm
Revision 1.348: download - view: text, annotated - select for diffs
Fri Apr 22 17:22:29 2016 UTC (8 years, 1 month ago) by musolffc
Branches: MAIN
CVS tags: HEAD

Limiting access to "private" resources

Private resources will now only show up in search results for the author and only if they are logged into the server on which it was published.

The use of private resources was discontinued in 2008.  This only applies to older resources.

1: # The LearningOnline Network with CAPA 2: # Search Catalog 3: # 4: # $Id: lonsearchcat.pm,v 1.348 2016/04/22 17:22:29 musolffc Exp $ 5: # 6: # Copyright Michigan State University Board of Trustees 7: # 8: # This file is part of the LearningOnline Network with CAPA (LON-CAPA). 9: # 10: # LON-CAPA is free software; you can redistribute it and/or modify 11: # it under the terms of the GNU General Public License as published by 12: # the Free Software Foundation; either version 2 of the License, or 13: # (at your option) any later version. 14: # 15: # LON-CAPA is distributed in the hope that it will be useful, 16: # but WITHOUT ANY WARRANTY; without even the implied warranty of 17: # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 18: # GNU General Public License for more details. 19: # 20: # You should have received a copy of the GNU General Public License 21: # along with LON-CAPA; if not, write to the Free Software 22: # Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA 23: # 24: # /home/httpd/html/adm/gpl.txt 25: # 26: # http://www.lon-capa.org/ 27: # 28: ############################################################################### 29: ############################################################################### 30: 31: =pod 32: 33: =head1 NAME 34: 35: lonsearchcat - LONCAPA Search Interface 36: 37: =head1 SYNOPSIS 38: 39: Search interface to LON-CAPAs digital library 40: 41: =head1 DESCRIPTION 42: 43: This module enables searching for a distributed browseable catalog. 44: 45: This is part of the LearningOnline Network with CAPA project 46: described at http://www.lon-capa.org. 47: 48: lonsearchcat presents the user with an interface to search the LON-CAPA 49: digital library. lonsearchcat also initiates the execution of a search 50: by sending the search parameters to LON-CAPA servers. The progress of 51: search (on a server basis) is displayed to the user in a separate window. 52: 53: =head1 Internals 54: 55: =cut 56: 57: ############################################################################### 58: ############################################################################### 59: 60: package Apache::lonsearchcat; 61: 62: use strict; 63: use Apache::Constants qw(:common :http); 64: use Apache::lonnet; 65: use Apache::File(); 66: use CGI qw(:standard); 67: use Text::Query; 68: use GDBM_File; 69: use Apache::loncommon(); 70: use Apache::lonmysql(); 71: use Apache::lonmeta; 72: use Apache::lonhtmlcommon; 73: use Apache::lonlocal; 74: use LONCAPA::lonmetadata(); 75: use HTML::Entities(); 76: use Parse::RecDescent; 77: use Apache::lonnavmaps; 78: use Apache::lonindexer(); 79: use Apache::lonwishlist(); 80: use LONCAPA; 81: use Time::HiRes qw(sleep); 82: 83: ###################################################################### 84: ###################################################################### 85: ## 86: ## Global variables 87: ## 88: ###################################################################### 89: ###################################################################### 90: my %groupsearch_db; # Database hash used to save values for the 91: # groupsearch RAT interface. 92: my %persistent_db; # gdbm hash which holds data which is supposed to 93: # persist across calls to lonsearchcat.pm 94: 95: # The different view modes and associated functions 96: 97: my %Views = ("detailed" => \&detailed_citation_view, 98: "detailedpreview" => \&detailed_citation_preview, 99: "summary" => \&summary_view, 100: "summarypreview" => \&summary_preview, 101: "fielded" => \&fielded_format_view, 102: "xml" => \&xml_sgml_view, 103: "compact" => \&compact_view); 104: 105: ###################################################################### 106: ###################################################################### 107: sub handler { 108: my $r = shift; 109: # &set_defaults(); 110: # 111: # set form defaults 112: # 113: my $hidden_fields;# Hold all the hidden fields used to keep track 114: # of the search system state 115: my $importbutton; # button to take the selected results and go to group 116: # sorting 117: my $diropendb; # The full path to the (temporary) search database file. 118: # This is set and used in &handler() and is also used in 119: # &output_results(). 120: 121: # 122: my $closebutton; # button that closes the search window 123: # This button is different for the RAT compared to 124: # normal invocation. 125: # 126: &Apache::loncommon::content_type($r,'text/html'); 127: $r->send_http_header; 128: return OK if $r->header_only; 129: ## 130: ## Prevent caching of the search interface window. Hopefully this means 131: ## we will get the launch=1 passed in a little more. 132: &Apache::loncommon::no_cache($r); 133: ## 134: ## Pick up form fields passed in the links. 135: ## 136: &Apache::loncommon::get_unprocessed_cgi($ENV{'QUERY_STRING'}, 137: ['catalogmode','launch','acts','mode','form','element','pause', 138: 'phase','persistent_db_id','table','start','show', 139: 'cleargroupsort','titleelement','area','inhibitmenu']); 140: ## 141: ## The following is a trick - we wait a few seconds if asked to so 142: ## the daemon running the search can get ahead of the daemon 143: ## printing the results. We only need (theoretically) to do 144: ## this once, so the pause indicator is deleted 145: ## 146: if (exists($env{'form.pause'})) { 147: sleep(0.1); 148: delete($env{'form.pause'}); 149: } 150: ## 151: ## Initialize global variables 152: ## 153: my $domain = $r->dir_config('lonDefDomain'); 154: my $temp_file_dir = LONCAPA::tempdir(); 155: $diropendb= $temp_file_dir . 156: "$env{'user.domain'}_$env{'user.name'}_sel_res.db"; 157: # 158: # set the name of the persistent database 159: # $env{'form.persistent_db_id'} can only have digits in it. 160: if (! exists($env{'form.persistent_db_id'}) || 161: ($env{'form.persistent_db_id'} =~ /\D/) || 162: ($env{'form.launch'} eq '1')) { 163: $env{'form.persistent_db_id'} = time; 164: } 165: 166: my $persistent_db_file = $temp_file_dir . 167: &escape($domain). 168: '_'.&escape($env{'user.name'}). 169: '_'.$env{'form.persistent_db_id'}.'_persistent_search.db'; 170: ## 171: &Apache::lonhtmlcommon::clear_breadcrumbs(); 172: 173: my @allowed_searches = ('portfolio'); 174: if (&Apache::lonnet::allowed('bre',$env{'request.role.domain'}) eq 'F') { 175: push(@allowed_searches,'res'); 176: } 177: my $crumb_text = 'Portfolio Search'; 178: if (@allowed_searches ==2) { 179: $crumb_text = 'Portfolio and Catalog Search'; 180: } 181: &Apache::lonhtmlcommon::add_breadcrumb 182: ({href=>'/adm/searchcat?'. 183: &Apache::loncommon::inhibit_menu_check(). 184: '&catalogmode='.$env{'form.catalogmode'}. 185: '&launch='.$env{'form.launch'}. 186: '&mode='.$env{'form.mode'}, 187: text=>"$crumb_text", 188: target=>'_top', 189: bug=>'Searching',}); 190: # 191: if ($env{'form.phase'} !~ m/(basic|adv|course)_search/) { 192: if (! &get_persistent_form_data($persistent_db_file)) { 193: if ($env{'form.phase'} =~ /(run_search|results)/) { 194: &Apache::lonnet::logthis('lonsearchcat:'. 195: 'Unable to recover data from '. 196: $persistent_db_file); 197: my $msg = 198: &mt('We were unable to retrieve data describing your search.'). 199: ' '.&mt('This is a serious error and has been logged.'). 200: '<br />'. 201: &mt('Please alert your LON-CAPA administrator.'); 202: &Apache::loncommon::simple_error_page( 203: $r,'Search Error', 204: $msg, 205: {'no_auto_mt_msg' => 1}); 206: return OK; 207: } 208: } 209: } else { 210: &clean_up_environment(); 211: } 212: ## 213: ## Clear out old values from groupsearch database 214: ## 215: untie %groupsearch_db if (tied(%groupsearch_db)); 216: if (($env{'form.cleargroupsort'} eq '1') || 217: (($env{'form.launch'} eq '1') && 218: ($env{'form.catalogmode'} eq 'import'))) { 219: if (tie(%groupsearch_db,'GDBM_File',$diropendb,&GDBM_WRCREAT(),0640)) { 220: &start_fresh_session(); 221: untie %groupsearch_db; 222: delete($env{'form.cleargroupsort'}); 223: } else { 224: # This is a stupid error to give to the user. 225: # It really tells them nothing. 226: my $msg = 'Unable to tie hash to db file.'; 227: &Apache::loncommon::simple_error_page($r,'Search Error', 228: $msg); 229: return OK; 230: } 231: } 232: ## 233: ## Configure hidden fields 234: ## 235: $hidden_fields = '<input type="hidden" name="persistent_db_id" value="'. 236: $env{'form.persistent_db_id'}.'" />'."\n"; 237: if (exists($env{'form.catalogmode'})) { 238: $hidden_fields .= &hidden_field('catalogmode'); 239: } 240: if (exists($env{'form.form'})) { 241: $hidden_fields .= &hidden_field('form'); 242: } 243: if (exists($env{'form.element'})) { 244: $hidden_fields .= &hidden_field('element'); 245: } 246: if (exists($env{'form.titleelement'})) { 247: $hidden_fields .= &hidden_field('titleelement'); 248: } 249: if (exists($env{'form.mode'})) { 250: $hidden_fields .= &hidden_field('mode'); 251: } 252: if (exists($env{'form.area'})) { 253: $hidden_fields .= &hidden_field('area'); 254: } 255: if (exists($env{'form.inhibitmenu'})) { 256: $hidden_fields .= &hidden_field('inhibitmenu'); 257: } 258: ## 259: ## Configure dynamic components of interface 260: ## 261: if ($env{'form.catalogmode'} eq 'interactive') { 262: $closebutton="<input type='button' name='close' value='".&mt('Close')."' "; 263: if ($env{'form.phase'} =~ /(results|run_search)/) { 264: $closebutton .="onclick='parent.close()'"; 265: } else { 266: $closebutton .="onclick='self.close()'"; 267: } 268: $closebutton .=" />\n"; 269: } elsif ($env{'form.catalogmode'} eq 'import') { 270: $closebutton="<input type='button' name='close' value='".&mt('Close')."' "; 271: if ($env{'form.phase'} =~ /(results|run_search)/) { 272: $closebutton .="onclick='parent.close()'"; 273: } else { 274: $closebutton .="onclick='self.close()'"; 275: } 276: $closebutton .= " />"; 277: my $txt_import = &mt('IMPORT'); 278: $importbutton=<<END; 279: <input type='button' name='import' value='$txt_import' 280: onclick='javascript:select_group()' /> 281: END 282: } else { 283: $closebutton = ''; 284: $importbutton = ''; 285: } 286: ## 287: ## Sanity checks on form elements 288: ## 289: if (!defined($env{'form.viewselect'})) { 290: $env{'form.viewselect'} ="summary"; 291: } 292: $env{'form.phase'} = 'disp_basic' if (! exists($env{'form.phase'})); 293: $env{'form.show'} = 20 if (! exists($env{'form.show'})); 294: # 295: $env{'form.searchmode'} = 'basic' if (! exists($env{'form.searchmode'})); 296: if ($env{'form.phase'} eq 'adv_search' || 297: $env{'form.phase'} eq 'disp_adv') { 298: $env{'form.searchmode'} = 'advanced'; 299: } 300: # 301: if ($env{'form.searchmode'} eq 'advanced') { 302: my $srchtype = 'Catalog'; 303: if ($env{'form.area'} eq 'portfolio') { 304: $srchtype = 'Portfolio'; 305: } 306: &Apache::lonhtmlcommon::add_breadcrumb 307: ({href=>'/adm/searchcat?'.&Apache::loncommon::inhibit_menu_check(). 308: '&phase=disp_adv'. 309: '&catalogmode='.$env{'form.catalogmode'}. 310: '&launch='.$env{'form.launch'}. 311: '&mode='.$env{'form.mode'}, 312: text=>"Advanced $srchtype Search", 313: bug=>'Searching',}); 314: } 315: ## 316: ## Switch on the phase 317: ## 318: if ($env{'form.phase'} eq 'disp_basic') { 319: &print_basic_search_form($r,$closebutton,$hidden_fields); 320: } elsif ($env{'form.phase'} eq 'disp_adv') { 321: &print_advanced_search_form($r,$closebutton,$hidden_fields); 322: } elsif ($env{'form.phase'} eq 'results') { 323: &display_results($r,$importbutton,$closebutton,$diropendb, 324: $env{'form.area'}); 325: } elsif ($env{'form.phase'} =~ /^(sort|run_search)$/) { 326: my ($query,$customquery,$customshow,$libraries,$pretty_string,$domainsref) = 327: &get_persistent_data($persistent_db_file, 328: ['query','customquery','customshow', 329: 'libraries','pretty_string','domains']); 330: if ($env{'form.phase'} eq 'sort') { 331: &print_sort_form($r,$pretty_string); 332: } elsif ($env{'form.phase'} eq 'run_search') { 333: &run_search($r,$query,$customquery,$customshow, 334: $libraries,$pretty_string,$env{'form.area'},$domainsref); 335: } 336: } elsif(($env{'form.phase'} eq 'basic_search') || 337: ($env{'form.phase'} eq 'adv_search')) { 338: # 339: # We are running a search, try to parse it 340: my ($query,$customquery,$customshow,$libraries,$domains) = 341: (undef,undef,undef,undef,undef); 342: my $pretty_string; 343: if ($env{'form.phase'} eq 'basic_search') { 344: ($query,$pretty_string,$libraries,$domains) = 345: &parse_basic_search($r,$closebutton,$hidden_fields); 346: return OK if (! defined($query)); 347: &make_persistent({ basicexp => $env{'form.basicexp'}}, 348: $persistent_db_file); 349: } else { # Advanced search 350: ($query,$customquery,$customshow,$libraries,$pretty_string,$domains) 351: = &parse_advanced_search($r,$closebutton,$hidden_fields); 352: return OK if (! defined($query)); 353: } 354: &make_persistent({ query => $query, 355: customquery => $customquery, 356: customshow => $customshow, 357: libraries => $libraries, 358: pretty_string => $pretty_string, 359: domains => $domains }, 360: $persistent_db_file); 361: # 362: # Set up table 363: if (! defined(&create_results_table($env{'form.area'}))) { 364: my $errorstring=&Apache::lonmysql::get_error(); 365: &Apache::lonnet::logthis('lonsearchcat.pm: Unable to create '. 366: 'needed table. lonmysql error:'. 367: $errorstring); 368: 369: my $msg = 370: 'Unable to create table in which to save search results. '. 371: 'The search has been aborted.'; 372: &Apache::loncommon::simple_error_page($r,'Search Error', 373: $msg); 374: return OK; 375: } 376: delete($env{'form.launch'}); 377: if (! &make_form_data_persistent($r,$persistent_db_file)) { 378: my $msg= 379: 'Unable to properly save search information. '. 380: 'The search has been aborted.'; 381: &Apache::loncommon::simple_error_page($r,'Search Error', 382: $msg); 383: return OK; 384: } 385: ## 386: ## Print out the frames interface 387: ## 388: if (defined($query)) { 389: &print_frames_interface($r); 390: } 391: } 392: return OK; 393: } 394: 395: # 396: # The mechanism used to store values away and retrieve them does not 397: # handle the case of missing environment variables being significant. 398: # 399: # This routine sets non existant checkbox form elements to ''. 400: # 401: sub clean_up_environment { 402: if ($env{'form.phase'} eq 'basic_search') { 403: if (! exists($env{'form.related'})) { 404: $env{'form.related'} = ''; 405: } 406: if (! exists($env{'form.domains'})) { 407: $env{'form.domains'} = ''; 408: } 409: } elsif ($env{'form.phase'} eq 'adv_search') { 410: foreach my $field ('title','keywords','notes', 411: 'abstract','standards','mime') { 412: if (! exists($env{'form.'.$field.'_related'})) { 413: $env{'form.'.$field.'_related'} = ''; 414: } 415: } 416: } elsif ($env{'form.phase'} eq 'course_search') { 417: if (! exists($env{'form.crsrelated'})) { 418: $env{'form.crsrelated'} = ''; 419: } 420: } 421: } 422: 423: sub hidden_field { 424: my ($name,$value) = @_; 425: if (! defined($value)) { 426: $value = $env{'form.'.$name}; 427: } 428: return '<input type="hidden" name="'.$name.'" value="'.$value.'" />'.$/; 429: } 430: 431: ###################################################################### 432: 433: =pod 434: 435: =over 4 436: 437: =item &print_basic_search_form() 438: 439: Prints the form for the basic search. Sorry the name is so cryptic. 440: 441: =cut 442: 443: ###################################################################### 444: ###################################################################### 445: sub print_basic_search_form { 446: my ($r,$closebutton,$hidden_fields) = @_; 447: my $result = ($env{'form.catalogmode'} ne 'import'); 448: my $bread_crumb = 449: &Apache::lonhtmlcommon::breadcrumbs('Searching','Search_Basic', 450: $env{'form.catalogmode'} ne 'import'); 451: my $scrout = &Apache::loncommon::start_page('Content Library').$bread_crumb; 452: # Search form for resource space 453: if (&Apache::lonnet::allowed('bre',$env{'request.role.domain'}) eq 'F') { 454: $scrout .= &setup_basic_search($r,'res',$hidden_fields,$closebutton); 455: $scrout .= '<hr /><br />'; 456: } 457: # Search form for accessible portfolio files 458: $scrout.= &setup_basic_search($r,'portfolio',$hidden_fields,$closebutton); 459: $scrout .= &Apache::loncommon::end_page(); 460: $r->print($scrout); 461: return; 462: } 463: 464: sub setup_basic_search { 465: my ($r,$area,$hidden_fields,$closebutton) = @_; 466: # Define interface components 467: my %lt = &Apache::lonlocal::texthash ( 468: res => 'LON-CAPA Catalog Search', 469: portfolio => 'Portfolio Search', 470: ); 471: my ($userelatedwords,$onlysearchdomain,$inclext,$adv_search_link,$scrout); 472: 473: $userelatedwords = '<label>' 474: .&Apache::lonhtmlcommon::checkbox( 475: 'related', 476: $env{'form.related'}, 477: 'related') 478: .' ' 479: .&mt('use related words') 480: .'</label>'; 481: 482: $onlysearchdomain = '<label>' 483: .&Apache::lonhtmlcommon::checkbox( 484: 'domains', 485: $env{'form.domains'}, 486: $r->dir_config('lonDefDomain')) 487: .' ' 488: .&mt('only search domain [_1]' 489: ,'<b>'.$r->dir_config('lonDefDomain').'</b>') 490: .'</label>'; 491: 492: $adv_search_link = '<a href="/adm/searchcat?'. 493: &Apache::loncommon::inhibit_menu_check(). 494: '&phase=disp_adv'. 495: '&catalogmode='.$env{'form.catalogmode'}. 496: '&launch='.$env{'form.launch'}. 497: '&mode='.$env{'form.mode'}. 498: '&area='.$area. 499: '&form='.$env{'form.form'}. 500: '&titleelement='.$env{'form.titleelement'}. 501: '&element='.$env{'form.element'}. 502: '">'.&mt('Advanced Search').'</a>'; 503: # 504: $scrout.='<form name="loncapa_search" method="post" '. 505: 'action="/adm/searchcat">'. 506: '<input type="hidden" name="phase" value="basic_search" />'. 507: $hidden_fields; 508: if (!exists($env{'form.area'})) { 509: $scrout .= '<input type="hidden" name="area" value="'.$area.'" />'; 510: } 511: # 512: $scrout .= '<div align="center">'.$/; 513: # if ($env{'request.course.id'}) { 514: $scrout .= '<h1>'.$lt{$area}.'</h1>'; 515: # } else { 516: # No need to tell them they are searching 517: # $scrout.= ('<br />'x2); 518: # } 519: $scrout.='<table>'. 520: '<tr><td align="center" valign="top">'. 521: &Apache::lonhtmlcommon::textbox('basicexp', 522: $env{'form.basicexp'},50). 523: '<br />'. 524: '<span class="LC_fontsize_small">'.&searchhelp().'</span>'.'</td>'. 525: '<td>'. 526: '<span class="LC_nobreak">'.(' 'x3).$adv_search_link.'</span>'.'<br />'. 527: '<span class="LC_nobreak">'.(' 'x1).$userelatedwords.'</span>'.'<br />'. 528: '<span class="LC_nobreak">'.(' 'x1).$onlysearchdomain.'</span>'.'<br />'. 529: '<span class="LC_nobreak">'.(' 'x1).$inclext.'</span>'.'<br />'. 530: '</td>'. 531: '</tr>'. 532: '</table>'.$/; 533: # 534: $scrout .= '<p>' 535: .&viewoptions() 536: .'</p>' 537: .'<p>' 538: .'<input type="submit" name="basicsubmit" ' 539: .'value="'.&mt('Search').'" />' 540: .' ' 541: .$closebutton 542: .'</p>'; 543: # 544: $scrout .= '</div>'.'</form>'; 545: return $scrout; 546: } 547: 548: ###################################################################### 549: ###################################################################### 550: 551: =pod 552: 553: =item &advanced_search_form() 554: 555: Prints the advanced search form. 556: 557: =cut 558: 559: ###################################################################### 560: ###################################################################### 561: sub print_advanced_search_form{ 562: my ($r,$closebutton,$hidden_fields) = @_; 563: my $bread_crumb = 564: &Apache::lonhtmlcommon::breadcrumbs('Searching','Search_Advanced', 565: $env{'form.catalogmode'} ne 'import'); 566: my %lt=&Apache::lonlocal::texthash('srch' => 'Search', 567: 'reset' => 'Reset', 568: 'help' => 'Help'); 569: my $advanced_buttons=<<"END"; 570: <p> 571: <input type="submit" name="advancedsubmit" value='$lt{"srch"}' /> 572: <input type="reset" name="reset" value='$lt{"reset"}' /> 573: $closebutton 574: </p> 575: END 576: my $srchtype = 'Catalog'; 577: my $jscript; 578: if ($env{'form.area'} eq 'portfolio') { 579: $srchtype = 'Portfolio'; 580: $jscript = '<script type="text/javascript"> 581: // <![CDATA[ 582: function additional_metadata() { 583: if (document.advsearch.newfield.checked) { 584: document.advsearch.phase.value = "disp_adv"; 585: document.advsearch.numaddedfields.value = parseInt(document.advsearch.numaddedfields.value) +1; 586: document.advsearch.submit(); 587: } 588: } 589: // ]]> 590: </script>'; 591: } 592: my $scrout= &Apache::loncommon::start_page("Advanced $srchtype Search", 593: $jscript); 594: $scrout .= $bread_crumb; 595: 596: $scrout .= '<form method="post" action="/adm/searchcat" name="advsearch">' 597: .$hidden_fields 598: .'<input type="hidden" name="phase" value="adv_search" />'; 599: 600: $scrout .= '<fieldset>'."\n" 601: .'<legend>'.&mt('Display Options').'</legend>'."\n" 602: .&viewoptions() 603: .'</fieldset>'; 604: 605: $scrout .= $advanced_buttons; 606: 607: $scrout .= &Apache::lonhtmlcommon::start_pick_box(); 608: 609: my %fields=&Apache::lonmeta::fieldnames(); 610: 611: # Standard Metadata 612: $scrout .= &Apache::lonhtmlcommon::row_headline() 613: .'<h3>'.&mt("Standard $srchtype Metadata").'</h3>' 614: .&searchhelp() 615: .&Apache::lonhtmlcommon::row_closure(); 616: my %related_word_search = 617: ('title' => 1, 618: 'author' => 0, 619: 'owner' => 0, 620: 'authorspace' => 0, 621: 'modifyinguser'=> 0, 622: 'keywords' => 1, 623: 'notes' => 1, 624: 'abstract' => 1, 625: 'standards'=> 1, 626: 'mime' => 1, 627: 'subject' => 1, 628: ); 629: # 630: foreach my $field ('title','author','subject','owner','authorspace', 631: 'modifyinguser','keywords','notes','abstract', 632: 'standards','mime') { 633: $scrout .= &Apache::lonhtmlcommon::row_title(&titlefield($fields{$field})) 634: .&Apache::lonmeta::prettyinput($field, 635: $env{'form.'.$field}, 636: $field, 637: 'advsearch', 638: $related_word_search{$field}, 639: '', 640: $env{'form.'.$field.'_related'}, 641: 50); 642: if ($related_word_search{$field}) { 643: $scrout .= &mt('related words'); 644: } else { 645: $scrout .= ''; 646: } 647: $scrout .= &Apache::lonhtmlcommon::row_closure(); 648: } 649: foreach my $field ('lowestgradelevel','highestgradelevel') { 650: $scrout .= &Apache::lonhtmlcommon::row_title(&titlefield($fields{$field})) 651: .&Apache::lonmeta::prettyinput($field, 652: $env{'form.'.$field}, 653: $field, 654: 'advsearch', 655: 0) 656: .&Apache::lonhtmlcommon::row_closure(); 657: } 658: 659: $scrout .= &Apache::lonhtmlcommon::row_title(&titlefield(&mt('MIME Type Category'))) 660: .&Apache::loncommon::filecategoryselect('category', 661: $env{'form.category'}) 662: .&Apache::lonhtmlcommon::row_closure(); 663: 664: $scrout .= &Apache::lonhtmlcommon::row_title(&titlefield(&mt('Domains'))) 665: .&Apache::loncommon::domain_select('domains', 666: $env{'form.domains'},1) 667: .&Apache::lonhtmlcommon::row_closure(); 668: 669: # Misc metadata 670: if ($env{'form.area'} ne 'portfolio') { 671: $scrout .= &Apache::lonhtmlcommon::row_title(&titlefield(&mt('Copyright/Distribution'))) 672: .&Apache::lonmeta::selectbox('copyright', 673: $env{'form.copyright'}, 674: \&Apache::loncommon::copyrightdescription, 675: ( undef, 676: &Apache::loncommon::copyrightids) 677: ) 678: .&Apache::lonhtmlcommon::row_closure(); 679: } 680: 681: $scrout .= &Apache::lonhtmlcommon::row_title(&titlefield(&mt('Language'))) 682: .&Apache::lonmeta::selectbox('language', 683: $env{'form.language'}, 684: \&Apache::loncommon::languagedescription, 685: ('any',&Apache::loncommon::languageids) 686: ) 687: .&Apache::lonhtmlcommon::row_closure(); 688: 689: # Portfolio Metadata 690: if ($env{'form.area'} eq 'portfolio') { 691: # Added fields 692: my $curnumadd = $env{'form.numaddedfields'}; 693: if ($curnumadd eq '') { 694: $curnumadd = 1; 695: } 696: $scrout .= &Apache::lonhtmlcommon::row_headline() 697: .'<h3>'.&mt('Custom Metadata fields').'</h3>' 698: .&Apache::lonhtmlcommon::row_closure() 699: .&Apache::lonhtmlcommon::row_title('') 700: .&mt('Field Name').' | '.&mt('Field Value(s)') 701: .&Apache::lonhtmlcommon::row_closure(); 702: 703: for (my $j=0; $j<$curnumadd; $j++) { 704: my $num = $j+1; 705: $scrout .= &Apache::lonhtmlcommon::row_title(&mt('Custom metadata [_1]',$num)) 706: .'<input type="text"' 707: .' name="addedfield_'.$j.'" size="10"' 708: .' value="'.$env{'form.addedfield_'.$j}.'" />' 709: .' ' 710: .'<input type="text" ' 711: .'name="addedvalues_'.$j.'" size="15"' 712: .' value="'.$env{'form.addedvalues_'.$j}.'" />' 713: .&Apache::lonhtmlcommon::row_closure(); 714: } 715: $scrout .= &Apache::lonhtmlcommon::row_title('') 716: .'<label>' 717: .'<input type="checkbox" name="newfield"' 718: .' value="1" onclick="javascript:additional_metadata()" />' 719: .&mt('Another custom field/value pair?').'</label>' 720: .'<input type="hidden" name="numaddedfields"' 721: .' value="'.$curnumadd.'" />' 722: .&Apache::lonhtmlcommon::row_closure(); 723: } else { 724: # 725: # Dynamic metadata 726: $scrout .= &Apache::lonhtmlcommon::row_headline() 727: .'<h3>'.&mt('Problem Statistics').'</h3>' 728: .&Apache::lonhtmlcommon::row_closure(); 729: $scrout .= &Apache::lonhtmlcommon::row_title('') 730: .&mt('Minimum').' | '.&mt('Maximum') 731: .&Apache::lonhtmlcommon::row_closure(); 732: foreach my $statistic 733: ({ name=>'count', 734: description=>'Network-wide number of accesses (hits)',}, 735: { name=>'stdno', 736: description=> 737: 'Statistics calculated for number of students',}, 738: { name => 'avetries', 739: description=>'Average number of tries till solved',}, 740: { name => 'difficulty', 741: description=>'Degree of difficulty',}, 742: { name => 'disc', 743: description=>'Degree of discrimination'}) { 744: $scrout .= &Apache::lonhtmlcommon::row_title(&titlefield(&mt($statistic->{'description'}))) 745: .'<input type="text" name="'.$statistic->{'name'} 746: .'_min" value="" size="6" />' 747: .' ' 748: .'<input type="text" name="'.$statistic->{'name'} 749: .'_max" value="" size="6" />' 750: .&Apache::lonhtmlcommon::row_closure(); 751: } 752: 753: $scrout .= &Apache::lonhtmlcommon::row_headline() 754: .'<h3>'.&mt('Evaluation Data').'</h3>' 755: .&Apache::lonhtmlcommon::row_closure(); 756: $scrout .= &Apache::lonhtmlcommon::row_title('') 757: .&mt('Minimum').' | '.&mt('Maximum') 758: .&Apache::lonhtmlcommon::row_closure(); 759: foreach my $evaluation 760: ( { name => 'clear', 761: description => 'Material presented in clear way'}, 762: { name =>'depth', 763: description => 'Material covered with sufficient depth'}, 764: { name => 'helpful', 765: description => 'Material is helpful'}, 766: { name => 'correct', 767: description => 'Material appears to be correct'}, 768: { name => 'technical', 769: description => 'Resource is technically correct'}){ 770: $scrout .= &Apache::lonhtmlcommon::row_title(&titlefield(&mt($evaluation->{'description'}))) 771: .'<input type="text" name="' 772: .$evaluation->{'name'}.'_min" value="" size="6" />' 773: .' ' 774: .'<input type="text" name="' 775: .$evaluation->{'name'}.'_max" value="" size="6" />' 776: .&Apache::lonhtmlcommon::row_closure(); 777: } 778: } 779: # 780: # Creation/Modification date limits 781: $scrout .= &Apache::lonhtmlcommon::row_headline() 782: .'<h3>'.&mt('Creation and Modification dates').'</h3>' 783: .&Apache::lonhtmlcommon::row_closure(); 784: $scrout .= &Apache::lonhtmlcommon::row_title('') 785: .&mt('Month[_1]Day[_2]Year',' 'x14,' 'x6) 786: .&Apache::lonhtmlcommon::row_closure(); 787: 788: my $cafter = 789: &Apache::lonhtmlcommon::date_setter('advsearch', # formname 790: 'creationdate1', # fieldname 791: 0, # current value 792: '', # special 793: 1, # includeempty 794: '', # state 795: 1, # no_hh_mm_ss 796: ); 797: my $cbefore = 798: &Apache::lonhtmlcommon::date_setter('advsearch', # formname 799: 'creationdate2', # fieldname 800: 0, # current value 801: '', # special 802: 1, # includeempty 803: '', # state 804: 1, # no_hh_mm_ss 805: ); 806: $scrout .= &Apache::lonhtmlcommon::row_title(&mt('Created between')) 807: .$cafter 808: .&Apache::lonhtmlcommon::row_closure(1) 809: .&Apache::lonhtmlcommon::row_title(&mt('and')) 810: .$cbefore 811: .&Apache::lonhtmlcommon::row_closure(); 812: 813: my $lafter = 814: &Apache::lonhtmlcommon::date_setter('advsearch', 815: 'revisiondate1', 816: 0, # current value 817: '', # special 818: 1, # includeempty 819: '', # state 820: 1, # no_hh_mm_ss 821: ); 822: my $lbefore = 823: &Apache::lonhtmlcommon::date_setter('advsearch', 824: 'revisiondate2', 825: 0, # current value 826: '', # special 827: 1, # includeempty 828: '', # state 829: 1, # no_hh_mm_ss 830: ); 831: $scrout .= &Apache::lonhtmlcommon::row_title(&mt('Last modified between')) 832: .$lafter 833: .&Apache::lonhtmlcommon::row_closure(1) 834: .&Apache::lonhtmlcommon::row_title(&mt('and')) 835: .$lbefore 836: .&Apache::lonhtmlcommon::row_closure(1); # Last row of total pick_box 837: 838: $scrout .= &Apache::lonhtmlcommon::end_pick_box(); 839: 840: $scrout .= $advanced_buttons 841: .'</form>'; 842: 843: $scrout .= &Apache::loncommon::end_page(); 844: $r->print($scrout); 845: return; 846: } 847: 848: ###################################################################### 849: ###################################################################### 850: 851: =pod 852: 853: =item &titlefield() 854: 855: Inputs: title text 856: 857: Outputs: titletext with font wrapper 858: 859: =cut 860: 861: ###################################################################### 862: ###################################################################### 863: sub titlefield { 864: my $title=shift; 865: return $title; 866: } 867: 868: ###################################################################### 869: ###################################################################### 870: 871: =pod 872: 873: =item viewoptiontext() 874: 875: Inputs: codename for view option 876: 877: Outputs: displayed text 878: 879: =cut 880: 881: ###################################################################### 882: ###################################################################### 883: sub viewoptiontext { 884: my $code=shift; 885: my %desc=&Apache::lonlocal::texthash 886: ('detailed' => "Detailed Citation View", 887: 'xml' => 'XML/SGML', 888: 'compact' => 'Compact View', 889: 'fielded' => 'Fielded Format', 890: 'summary' => 'Summary View', 891: 'summarypreview' => 'Summary Preview', 892: 'detailedpreview' => 'Detailed Citation Preview'); 893: return $desc{$code}; 894: } 895: 896: ###################################################################### 897: ###################################################################### 898: 899: =pod 900: 901: =item viewoptions() 902: 903: Inputs: none 904: 905: Outputs: text for box with view options 906: 907: =cut 908: 909: ###################################################################### 910: ###################################################################### 911: sub viewoptions { 912: my $scrout; 913: if (! defined($env{'form.viewselect'})) { 914: $env{'form.viewselect'}='detailed'; 915: } 916: $scrout .= '<span class="LC_nobreak">' 917: .&mt('Type:').' ' 918: .&Apache::lonmeta::selectbox('viewselect', 919: $env{'form.viewselect'}, 920: \&viewoptiontext, 921: sort(keys(%Views))) 922: .'</span>'; 923: my $countselect = &Apache::lonmeta::selectbox('show', 924: $env{'form.show'}, 925: undef, 926: (10,20,50,100,1000,10000)); 927: $scrout .= ' <span class="LC_nobreak">' 928: .&mt('Records per Page:').' '.$countselect 929: .'</span>'.$/; 930: return $scrout; 931: } 932: 933: ###################################################################### 934: ###################################################################### 935: 936: =pod 937: 938: =item searchhelp() 939: 940: Inputs: none 941: 942: Outputs: return little blurb on how to enter searches 943: 944: =cut 945: 946: ###################################################################### 947: ###################################################################### 948: sub searchhelp { 949: return &mt('Enter words and quoted phrases'); 950: } 951: 952: ###################################################################### 953: ###################################################################### 954: 955: =pod 956: 957: =item &get_persistent_form_data() 958: 959: Inputs: filename of database 960: 961: Outputs: returns undef on database errors. 962: 963: This function is the reverse of &make_persistent() for form data. 964: Retrieve persistent data from %persistent_db. Retrieved items will have their 965: values unescaped. If a form value already exists in $env, it will not be 966: overwritten. Form values that are array references may have values appended 967: to them. 968: 969: =cut 970: 971: ###################################################################### 972: ###################################################################### 973: sub get_persistent_form_data { 974: my $filename = shift; 975: return 0 if (! -e $filename); 976: return undef if (! tie(%persistent_db,'GDBM_File',$filename, 977: &GDBM_READER(),0640)); 978: # 979: # These make sure we do not get array references printed out as 'values'. 980: my %arrays_allowed = ('form.domains'=>1); 981: # 982: # Loop through the keys, looking for 'form.' 983: foreach my $name (keys(%persistent_db)) { 984: next if ($name !~ /^form./); 985: # Kludgification begins! 986: if ($name eq 'form.domains' && 987: $env{'form.searchmode'} eq 'basic' && 988: $env{'form.phase'} ne 'disp_basic') { 989: next; 990: } 991: # End kludge (hopefully) 992: next if (exists($env{$name})); 993: my @values = map { 994: &unescape($_); 995: } split(',',$persistent_db{$name}); 996: next if (@values <1); 997: if ($arrays_allowed{$name}) { 998: $env{$name} = [@values]; 999: } else { 1000: $env{$name} = $values[0] if ($values[0]); 1001: } 1002: } 1003: untie (%persistent_db); 1004: return 1; 1005: } 1006: 1007: ###################################################################### 1008: ###################################################################### 1009: 1010: =pod 1011: 1012: =item &get_persistent_data() 1013: 1014: Inputs: filename of database, ref to array of values to recover. 1015: 1016: Outputs: array of values. Returns undef on error. 1017: 1018: This function is the reverse of &make_persistent(); 1019: Retrieve persistent data from %persistent_db. Retrieved items will have their 1020: values unescaped. If the item is 'domains; then the returned 1021: value will be a hash pointer. Otherwise, if the item contains 1022: commas (before unescaping), the returned value will be an array pointer. 1023: 1024: =cut 1025: 1026: ###################################################################### 1027: ###################################################################### 1028: sub get_persistent_data { 1029: my $filename = shift; 1030: my @Vars = @{shift()}; 1031: my @Values; # Return array 1032: return undef if (! -e $filename); 1033: return undef if (! tie(%persistent_db,'GDBM_File',$filename, 1034: &GDBM_READER(),0640)); 1035: foreach my $name (@Vars) { 1036: if (! exists($persistent_db{$name})) { 1037: push @Values, undef; 1038: next; 1039: } 1040: if ($name eq 'domains') { 1041: my %valueshash; 1042: my @items= map { &unescape($_); } split(',',$persistent_db{$name}); 1043: foreach my $item (@items) { 1044: if ($item =~ /=/) { 1045: my ($key,$val) = map { &unescape($_); } split(/=/,$item); 1046: $valueshash{$key} = $val; 1047: } 1048: } 1049: push(@Values,\%valueshash); 1050: } else { 1051: my @values = map { 1052: &unescape($_); 1053: } split(',',$persistent_db{$name}); 1054: if (@values <= 1) { 1055: push @Values,$values[0]; 1056: } else { 1057: push @Values,\@values; 1058: } 1059: } 1060: } 1061: untie (%persistent_db); 1062: return @Values; 1063: } 1064: 1065: ###################################################################### 1066: ###################################################################### 1067: 1068: =pod 1069: 1070: =item &make_persistent() 1071: 1072: Inputs: Hash of values to save, filename of persistent database. 1073: 1074: Store variables away to the %persistent_db. 1075: Values will be escaped. Values that are array pointers will have their 1076: elements escaped and concatenated in a comma separated string. Values 1077: that are hash pointers will have their keys and values escaped and 1078: concatenated in a comma separated string. 1079: 1080: =cut 1081: 1082: ###################################################################### 1083: ###################################################################### 1084: sub make_persistent { 1085: my %save = %{shift()}; 1086: my $filename = shift; 1087: return undef if (! tie(%persistent_db,'GDBM_File', 1088: $filename,&GDBM_WRCREAT(),0640)); 1089: foreach my $name (keys(%save)) { 1090: my @values=(); 1091: if (ref($save{$name}) eq 'ARRAY') { 1092: @values = @{$save{$name}}; 1093: } elsif (ref($save{$name}) eq 'HASH') { 1094: foreach my $key (%{$save{$name}}) { 1095: push(@values,&escape($key).'='.&escape($save{$name}{$key})); 1096: } 1097: } else { 1098: @values = $save{$name}; 1099: } 1100: # We handle array and hash references, but not recursively. 1101: my $store = join(',', map { &escape($_); } @values ); 1102: $persistent_db{$name} = $store; 1103: } 1104: untie(%persistent_db); 1105: return 1; 1106: } 1107: 1108: ###################################################################### 1109: ###################################################################### 1110: 1111: =pod 1112: 1113: =item &make_form_data_persistent() 1114: 1115: Inputs: filename of persistent database. 1116: 1117: Store most form variables away to the %persistent_db. 1118: Values will be escaped. Values that are array pointers will have their 1119: elements escaped and concatenated in a comma separated string. 1120: 1121: =cut 1122: 1123: ###################################################################### 1124: ###################################################################### 1125: sub make_form_data_persistent { 1126: my $r = shift; 1127: my $filename = shift; 1128: my %save; 1129: foreach (keys(%env)) { 1130: next if (!/^form/ || /submit/); 1131: $save{$_} = $env{$_}; 1132: } 1133: return &make_persistent(\%save,$filename); 1134: } 1135: 1136: ###################################################################### 1137: ###################################################################### 1138: 1139: =pod 1140: 1141: =item &parse_advanced_search() 1142: 1143: Parse advanced search form and return the following: 1144: 1145: =over 4 1146: 1147: =item $query Scalar containing an SQL query. 1148: 1149: =item $customquery Scalar containing a custom query. 1150: 1151: =item $customshow Scalar containing commands to show custom metadata. 1152: 1153: =item $libraries_to_query Reference to array of domains to search. 1154: 1155: =back 1156: 1157: =cut 1158: 1159: ###################################################################### 1160: ###################################################################### 1161: sub parse_advanced_search { 1162: my ($r,$closebutton,$hidden_fields)=@_; 1163: my @BasicFields = ('title','author','subject','keywords','url','version', 1164: 'notes','abstract','extension','owner','authorspace', 1165: # 'custommetadata','customshow', 1166: 'modifyinguser','standards','mime'); 1167: my @StatsFields = &statfields(); 1168: my @EvalFields = &evalfields(); 1169: my $fillflag=0; 1170: my $pretty_search_string = ""; 1171: # Clean up fields for safety 1172: for my $field (@BasicFields, 1173: 'creationdatestart_month','creationdatestart_day', 1174: 'creationdatestart_year','creationdateend_month', 1175: 'creationdateend_day','creationdateend_year', 1176: 'lastrevisiondatestart_month','lastrevisiondatestart_day', 1177: 'lastrevisiondatestart_year','lastrevisiondateend_month', 1178: 'lastrevisiondateend_day','lastrevisiondateend_year') { 1179: $env{'form.'.$field}=~s/[^\w\/\s\=\-\"\'.\*]//g; 1180: } 1181: foreach ('mode','form','element') { 1182: # is this required? Hmmm. 1183: next if (! exists($env{'form.'.$_})); 1184: $env{'form.'.$_}=&unescape($env{'form.'.$_}); 1185: $env{'form.'.$_}=~s/[^\w\/\s\=\-\"\']//g; 1186: } 1187: # Preprocess the category form element. 1188: $env{'form.category'} = 'any' if (! defined($env{'form.category'}) || 1189: ref($env{'form.category'})); 1190: # 1191: # Check to see if enough information was filled in 1192: foreach my $field (@BasicFields) { 1193: if (&filled($env{'form.'.$field})) { 1194: $fillflag++; 1195: } 1196: } 1197: foreach my $field (@StatsFields,@EvalFields) { 1198: if (&filled($env{'form.'.$field.'_max'})) { 1199: $fillflag++; 1200: } 1201: if (&filled($env{'form.'.$field.'_min'})) { 1202: $fillflag++; 1203: } 1204: } 1205: 1206: for my $field ('lowestgradelevel','highestgradelevel') { 1207: if ( $env{'form.'.$field} =~ /^\d+$/ && 1208: $env{'form.'.$field} > 0) { 1209: $fillflag++; 1210: } 1211: } 1212: if ($env{'form.area'} eq 'portfolio') { 1213: # Added metadata fields 1214: for (my $i=0; $i<$env{'form.numaddedfields'} ; $i++) { 1215: my $field = $env{'form.addedfield_'.$i}; 1216: $field =~ s/^\s*(\S*)\s*$/$1/; 1217: $field =~ s/\W/_/g; 1218: if ($field ne '') { 1219: $fillflag++; 1220: } 1221: } 1222: } 1223: if (! $fillflag) { 1224: &output_blank_field_error($r,$closebutton, 1225: 'phase=disp_adv',$hidden_fields); 1226: return ; 1227: } 1228: # Turn the form input into a SQL-based query 1229: my $query=''; 1230: my @queries; 1231: my $font = '<font color="#800000" face="helvetica">'; 1232: # Evaluate logical expression AND/OR/NOT phrase fields. 1233: foreach my $field (@BasicFields) { 1234: next if (!defined($env{'form.'.$field}) || $env{'form.'.$field} eq ''); 1235: my ($error,$SQLQuery) = 1236: &process_phrase_input($env{'form.'.$field}, 1237: $env{'form.'.$field.'_related'},$field); 1238: if (defined($error)) { 1239: &output_unparsed_phrase_error($r,$closebutton,'phase=disp_adv', 1240: $hidden_fields,$field); 1241: return; 1242: } else { 1243: $pretty_search_string .= 1244: $font.$field.'</font>: '.$env{'form.'.$field}; 1245: if ($env{'form.'.$field.'_related'}) { 1246: my @Words = 1247: &Apache::loncommon::get_related_words 1248: ($env{'form.'.$field}); 1249: if (@Words) { 1250: $pretty_search_string.= ' with related words: '. 1251: join(', ',@Words[0..4]); 1252: } else { 1253: $pretty_search_string.= ' with related words.'; 1254: } 1255: } 1256: $pretty_search_string .= '<br />'; 1257: push (@queries,$SQLQuery); 1258: } 1259: } 1260: # 1261: # Make the 'mime' from 'form.category' and 'form.extension' 1262: # 1263: my $searchphrase; 1264: if (exists($env{'form.category'}) && 1265: $env{'form.category'} !~ /^\s*$/ && 1266: $env{'form.category'} ne 'any') { 1267: my @extensions = &Apache::loncommon::filecategorytypes 1268: ($env{'form.category'}); 1269: if (scalar(@extensions) > 0) { 1270: $searchphrase = join(' OR ',@extensions); 1271: } 1272: } 1273: if (defined($searchphrase)) { 1274: my ($error,$SQLsearch) = &process_phrase_input($searchphrase,0,'mime'); 1275: push @queries,$SQLsearch; 1276: $pretty_search_string .=$font.'mime</font> contains <b>'. 1277: $searchphrase.'</b><br />'; 1278: } 1279: # 1280: # Evaluate option lists 1281: if ($env{'form.lowestgradelevel'} && 1282: $env{'form.lowestgradelevel'} ne '0' && 1283: $env{'form.lowestgradelevel'} =~ /^\d+$/) { 1284: push(@queries, 1285: '(lowestgradelevel>='.$env{'form.lowestgradelevel'}.')'); 1286: $pretty_search_string.="lowestgradelevel>=". 1287: $env{'form.lowestgradelevel'}."<br />\n"; 1288: } 1289: if ($env{'form.highestgradelevel'} && 1290: $env{'form.highestgradelevel'} ne '0' && 1291: $env{'form.highestgradelevel'} =~ /^\d+$/) { 1292: push(@queries, 1293: '(highestgradelevel<='.$env{'form.highestgradelevel'}.')'); 1294: $pretty_search_string.="highestgradelevel<=". 1295: $env{'form.highestgradelevel'}."<br />\n"; 1296: } 1297: if ($env{'form.language'} and $env{'form.language'} ne 'any') { 1298: push @queries,"(language like \"$env{'form.language'}\")"; 1299: $pretty_search_string.=$font."language</font>= ". 1300: &Apache::loncommon::languagedescription($env{'form.language'}). 1301: "<br />\n"; 1302: } 1303: if ($env{'form.copyright'} and $env{'form.copyright'} ne 'any') { 1304: push @queries,"(copyright like \"$env{'form.copyright'}\")"; 1305: $pretty_search_string.=$font."copyright</font> = ". 1306: &Apache::loncommon::copyrightdescription($env{'form.copyright'}). 1307: "<br />\n"; 1308: } 1309: if ($env{'form.area'} eq 'portfolio') { 1310: # 1311: # Added metadata fields 1312: for (my $i=0; $i<$env{'form.numaddedfields'} ; $i++) { 1313: my $field = $env{'form.addedfield_'.$i}; 1314: $field =~ s/^\s*(\S*)\s*$/$1/; 1315: $field =~ s/\W/_/g; 1316: $field =~ tr/A-Z/a-z/; 1317: if ($field ne '') { 1318: my $value = $env{'form.addedvalues_'.$i}; 1319: if ($value ne '') { 1320: $value =~ s/'/''/g; #' stupid emacs 1321: my ($error,$query) = 1322: &process_phrase_input($value,0,'pf.value'); 1323: if (!defined($error)) { 1324: push(@queries,"pf.field = '$field' AND $query"); 1325: $pretty_search_string .= 1326: $font.$field.'</font>: '. 1327: $env{'form.addedvalues_'.$i}.'<br />'; 1328: } 1329: } else { 1330: push(@queries,"pf.field = '$field' AND pf.value IS NULL"); 1331: } 1332: } 1333: } 1334: } else { 1335: # 1336: # Statistics 1337: foreach my $field (@StatsFields,@EvalFields) { 1338: my ($min,$max); 1339: if (exists($env{'form.'.$field.'_min'}) && 1340: $env{'form.'.$field.'_min'} ne '') { 1341: $min = $env{'form.'.$field.'_min'}; 1342: } 1343: if (exists($env{'form.'.$field.'_max'}) && 1344: $env{'form.'.$field.'_max'} ne '') { 1345: $max = $env{'form.'.$field.'_max'}; 1346: } 1347: next if (! defined($max) && ! defined($min)); 1348: if (defined($min) && defined($max)) { 1349: ($min,$max) = sort {$a <=>$b} ($min,$max); 1350: } 1351: if (defined($min) && $min =~ /^(\d+\.\d+|\d+|\.\d+)$/) { 1352: push(@queries,'('.$field.'>'.$min.')'); 1353: $pretty_search_string.=$font.$field.'</font>>'.$min.'<br />'; 1354: } 1355: if (defined($max) && $max =~ /^(\d+\.\d+|\d+|\.\d+)$/) { 1356: push(@queries,'('.$field.'<'.$max.')'); 1357: $pretty_search_string.=$font.$field.'</font><'.$max.'<br />'; 1358: } 1359: } 1360: } 1361: # 1362: # Evaluate date windows 1363: my $cafter = 1364: &Apache::lonhtmlcommon::get_date_from_form('creationdate1'); 1365: my $cbefore = 1366: &Apache::lonhtmlcommon::get_date_from_form('creationdate2'); 1367: if ($cafter > $cbefore) { 1368: my $tmp = $cafter; 1369: $cafter = $cbefore; 1370: $cbefore = $tmp; 1371: } 1372: my $mafter = 1373: &Apache::lonhtmlcommon::get_date_from_form('revisiondate1'); 1374: my $mbefore = 1375: &Apache::lonhtmlcommon::get_date_from_form('revisiondate2'); 1376: if ($mafter > $mbefore) { 1377: my $tmp = $mafter; 1378: $mafter = $mbefore; 1379: $mbefore = $tmp; 1380: } 1381: my ($datequery,$error,$prettydate)=&build_date_queries($cafter,$cbefore, 1382: $mafter,$mbefore); 1383: if (defined($error)) { 1384: &output_date_error($r,$error,$closebutton,$hidden_fields); 1385: } elsif (defined($datequery)) { 1386: # Here is where you would set up pretty_search_string to output 1387: # date query information. 1388: $pretty_search_string .= '<br />'.$prettydate.'<br />'; 1389: push @queries,$datequery; 1390: } 1391: # 1392: # Process form information for custom metadata querying 1393: my $customquery=undef; 1394: ## 1395: ## The custom metadata search was removed q long time ago mostly 1396: ## because I was unable to figureout exactly how it worked and could 1397: ## not imagine people actually using it. MH 1398: ## 1399: # if ($env{'form.custommetadata'}) { 1400: # $pretty_search_string .=$font."Custom Metadata Search</font>: <b>". 1401: # $env{'form.custommetadata'}."</b><br />\n"; 1402: # $customquery=&build_custommetadata_query('custommetadata', 1403: # $env{'form.custommetadata'}); 1404: # } 1405: my $customshow=undef; 1406: # if ($env{'form.customshow'}) { 1407: # $pretty_search_string .=$font."Custom Metadata Display</font>: <b>". 1408: # $env{'form.customshow'}."</b><br />\n"; 1409: # $customshow=$env{'form.customshow'}; 1410: # $customshow=~s/[^\w\s]//g; 1411: # my @fields=split(/\s+/,$customshow); 1412: # $customshow=join(" ",@fields); 1413: # } 1414: ## 1415: ## Deal with restrictions to given domains 1416: ## 1417: my ($libraries_to_query,$pretty_domains_string,$domains_to_query) = 1418: &parse_domain_restrictions(); 1419: if ($pretty_domains_string) { 1420: $pretty_search_string .= $pretty_domains_string."<br />\n"; 1421: } 1422: # 1423: if (@queries) { 1424: if ($env{'form.area'} eq 'portfolio') { 1425: $query ="SELECT pm.*,pa.keynum,pa.scope FROM portfolio_metadata pm, portfolio_access pa, portfolio_addedfields pf WHERE (pm.url = pa.url AND pf.url = pm.url AND (pa.start < UTC_TIMESTAMP() AND (pa.end IS NULL OR pa.end > UTC_TIMESTAMP())) AND (".join(') AND (',@queries).'))'; 1426: } else { 1427: $query="SELECT * FROM metadata WHERE (".join(") AND (",@queries).')'; 1428: } 1429: } elsif ($customquery) { 1430: $query = ''; 1431: } 1432: #&Apache::lonnet::logthis('advanced query = '.$/.$query); 1433: return ($query,$customquery,$customshow,$libraries_to_query, 1434: $pretty_search_string,$domains_to_query); 1435: } 1436: 1437: sub parse_domain_restrictions { 1438: my $libraries_to_query = undef; 1439: my $domains_to_query = undef; 1440: # $env{'form.domains'} can be either a scalar or an array reference. 1441: # We need an array. 1442: if (! exists($env{'form.domains'}) || $env{'form.domains'} eq '') { 1443: return (undef,'',undef); 1444: } 1445: my @allowed_domains = &Apache::loncommon::get_env_multiple('form.domains'); 1446: # 1447: my %domain_hash = (); 1448: my $pretty_domains_string; 1449: foreach (@allowed_domains) { 1450: $domain_hash{$_}++; 1451: } 1452: if ($domain_hash{'any'}) { 1453: $pretty_domains_string = &mt("in all LON-CAPA domains."); 1454: } else { 1455: if (@allowed_domains > 1) { 1456: $pretty_domains_string = &mt("in LON-CAPA domains:"); 1457: } else { 1458: $pretty_domains_string = &mt("in LON-CAPA domain "); 1459: } 1460: foreach (sort @allowed_domains) { 1461: $pretty_domains_string .= "<b>".$_."</b> "; 1462: } 1463: my %library_servers = &Apache::lonnet::get_unique_servers(\@allowed_domains, 1464: 'library'); 1465: my (%older_library_servers,%okdoms,%domains_for_id); 1466: map { $okdoms{$_} = 1; } @allowed_domains; 1467: foreach my $key (keys(%library_servers)) { 1468: if (&Apache::lonnet::get_server_loncaparev('',$key) =~ /^\'?(\d+)\.(\d+)/) { 1469: my $major = $1; 1470: my $minor = $2; 1471: if (($major < 2) || (($major == 2) && ($minor < 11))) { 1472: map { $older_library_servers{$_} = 1; } 1473: &Apache::lonnet::machine_ids($library_servers{$key}); 1474: } else { 1475: my %possdoms; 1476: map { $possdoms{$_}=1 if ($okdoms{$_}); } 1477: &Apache::lonnet::machine_domains($library_servers{$key}); 1478: $domains_for_id{$key} = join(',',sort(keys(%possdoms))); 1479: } 1480: } 1481: } 1482: my %servers = (%library_servers,%older_library_servers); 1483: $libraries_to_query = [keys(%servers)]; 1484: $domains_to_query = \%domains_for_id; 1485: } 1486: return ($libraries_to_query, 1487: $pretty_domains_string, 1488: $domains_to_query); 1489: } 1490: 1491: ###################################################################### 1492: ###################################################################### 1493: 1494: =pod 1495: 1496: =item &parse_basic_search() 1497: 1498: Parse the basic search form and return a scalar containing an sql query. 1499: 1500: =cut 1501: 1502: ###################################################################### 1503: ###################################################################### 1504: sub parse_basic_search { 1505: my ($r,$closebutton)=@_; 1506: # 1507: # Clean up fields for safety 1508: for my $field ('basicexp') { 1509: $env{"form.$field"}=~s/[^\w\s\'\"\!\-\*]//g; 1510: } 1511: foreach ('mode','form','element') { 1512: # is this required? Hmmm. 1513: next unless (exists($env{"form.$_"})); 1514: $env{"form.$_"}=&unescape($env{"form.$_"}); 1515: $env{"form.$_"}=~s/[^\w\/\s\=\-\"\']//g; 1516: } 1517: my ($libraries_to_query,$pretty_domains_string,$domains_to_query) = 1518: &parse_domain_restrictions(); 1519: # 1520: # Check to see if enough of a query is filled in 1521: my $search_string = $env{'form.basicexp'}; 1522: if (! &filled($search_string)) { 1523: &output_blank_field_error($r,$closebutton,'phase=disp_basic'); 1524: return OK; 1525: } 1526: my $pretty_search_string=$search_string; 1527: my @Queries; 1528: my @fields = ('title','author','subject','notes','abstract','keywords'); 1529: my $searchfield; 1530: if ($env{'form.area'} eq 'portfolio') { 1531: $searchfield = 'concat_ws(" ",pm.'.join(',pm.',@fields).')'; 1532: } else { 1533: $searchfield = 'concat_ws(" ",'.join(',',@fields).')'; 1534: } 1535: my ($error,$SQLQuery) = &process_phrase_input($search_string, 1536: $env{'form.related'}, 1537: $searchfield); 1538: if ($error) { 1539: &output_unparsed_phrase_error($r,$closebutton,'phase=disp_basic', 1540: '','basicexp'); 1541: return; 1542: } 1543: push(@Queries,$SQLQuery); 1544: #foreach my $q (@Queries) { 1545: # &Apache::lonnet::logthis(' '.$q); 1546: #} 1547: my $final_query; 1548: if ($env{'form.area'} eq 'portfolio') { 1549: $final_query = 'SELECT pm.*,pa.keynum,pa.scope FROM portfolio_metadata pm, portfolio_access pa WHERE (pm.url = pa.url AND (pa.start < UTC_TIMESTAMP() AND (pa.end IS NULL OR pa.end > UTC_TIMESTAMP())) AND '.join(" AND ",@Queries).')'; 1550: } else { 1551: $final_query = 'SELECT * FROM metadata WHERE '.join(" AND ",@Queries); 1552: } 1553: # 1554: if ($env{'form.related'}) { 1555: $pretty_search_string.=' '.&mt('(including related words)'); 1556: } 1557: if (defined($pretty_domains_string) && $pretty_domains_string ne '') { 1558: $pretty_search_string .= ' '.$pretty_domains_string; 1559: } 1560: $pretty_search_string .= "<br />\n"; 1561: $pretty_search_string =~ s:^<br /> and ::; 1562: &Apache::lonnet::logthis('simple search final query = '.$/.$final_query); 1563: return ($final_query,$pretty_search_string, 1564: $libraries_to_query,$domains_to_query); 1565: } 1566: 1567: 1568: ############################################################### 1569: ############################################################### 1570: 1571: my @Phrases; 1572: 1573: sub concat { 1574: my ($item) = @_; 1575: my $results = ''; 1576: foreach (@$item) { 1577: if (ref($_) eq 'ARRAY') { 1578: $results .= join(' ',@$_); 1579: } 1580: } 1581: return $results; 1582: } 1583: 1584: sub process_phrase_input { 1585: my ($phrase,$related,$field)=@_; 1586: #&Apache::lonnet::logthis('phrase = :'.$phrase.':'); 1587: my $grammar = <<'ENDGRAMMAR'; 1588: searchphrase: 1589: expression /^\Z/ { 1590: # &Apache::lonsearchcat::print_item(\@item,0); 1591: [@item]; 1592: } 1593: expression: 1594: phrase(s) { 1595: [@item]; 1596: } 1597: phrase: 1598: orword { 1599: [@item]; 1600: } 1601: | andword { 1602: [@item]; 1603: } 1604: | minusword { 1605: unshift(@::Phrases,$item[1]->[0]); 1606: unshift(@::Phrases,$item[1]->[1]); 1607: [@item]; 1608: } 1609: | word { 1610: unshift(@::Phrases,$item[1]); 1611: [@item]; 1612: } 1613: # 1614: orword: 1615: word 'OR' phrase { 1616: unshift(@::Phrases,'OR'); 1617: unshift(@::Phrases,$item[1]); 1618: [@item]; 1619: } 1620: | word 'or' phrase { 1621: unshift(@::Phrases,'OR'); 1622: unshift(@::Phrases,$item[1]); 1623: [@item]; 1624: } 1625: | minusword 'OR' phrase { 1626: unshift(@::Phrases,'OR'); 1627: unshift(@::Phrases,$item[1]->[0]); 1628: unshift(@::Phrases,$item[1]->[1]); 1629: [@item]; 1630: } 1631: | minusword 'or' phrase { 1632: unshift(@::Phrases,'OR'); 1633: unshift(@::Phrases,$item[1]->[0]); 1634: unshift(@::Phrases,$item[1]->[1]); 1635: [@item]; 1636: } 1637: andword: 1638: word phrase { 1639: unshift(@::Phrases,'AND'); 1640: unshift(@::Phrases,$item[1]); 1641: [@item]; 1642: } 1643: | minusword phrase { 1644: unshift(@::Phrases,'AND'); 1645: unshift(@::Phrases,$item[1]->[0]); 1646: unshift(@::Phrases,$item[1]->[1]); 1647: [@item]; 1648: } 1649: # 1650: minusword: 1651: '-' word { 1652: [$item[2],'NOT']; 1653: } 1654: word: 1655: "'" term(s) "'" { 1656: &Apache::lonsearchcat::concat(\@item); 1657: } 1658: | '"' term(s) '"' { 1659: &Apache::lonsearchcat::concat(\@item); 1660: } 1661: | term { 1662: $item[1]; 1663: } 1664: term: 1665: /[\w\Q:!@#$%^&*()+_=|{}<>,.;\\\/?\E\-]+/ { 1666: $item[1]; 1667: } 1668: ENDGRAMMAR 1669: # 1670: # The end result of parsing the phrase with the grammar is an array 1671: # @::Phrases. 1672: # $phrase = "gene splicing" or cat -> "gene splicing","OR","cat" 1673: # $phrase = "genetic engineering" -dna -> 1674: # "genetic engineering","AND","NOT","dna" 1675: # $phrase = cat or dog -poodle -> "cat","OR","dog","AND","NOT","poodle" 1676: undef(@::Phrases); 1677: my $p = new Parse::RecDescent($grammar); 1678: if (! defined($p->searchphrase($phrase))) { 1679: &Apache::lonnet::logthis('lonsearchcat:unable to process:'.$phrase); 1680: return 'Unable to process phrase '.$phrase; 1681: } 1682: # 1683: # Go through the phrases and make sense of them. 1684: # Apply modifiers NOT OR and AND to the phrases. 1685: my @NewPhrases; 1686: while(@::Phrases) { 1687: my $phrase = shift(@::Phrases); 1688: # &Apache::lonnet::logthis('phrase = '.$phrase); 1689: my $phrasedata; 1690: if ($phrase =~ /^(NOT|OR|AND)$/) { 1691: if ($phrase eq 'OR') { 1692: $phrasedata->{'or'}++; 1693: if (! @::Phrases) { $phrasedata = undef; last; } 1694: $phrase = shift(@::Phrases); 1695: } elsif ($phrase eq 'AND') { 1696: $phrasedata->{'and'}++; 1697: if (! @::Phrases) { $phrasedata = undef; last; } 1698: $phrase = shift(@::Phrases); 1699: } 1700: if ($phrase eq 'NOT') { 1701: $phrasedata->{'negate'}++; 1702: if (! @::Phrases) { $phrasedata = undef; last; } 1703: $phrase = shift(@::Phrases); 1704: } 1705: } 1706: $phrasedata->{'phrase'} = $phrase; 1707: if ($related) { 1708: my @NewWords; 1709: (undef,@NewWords) = &related_version($phrasedata->{'phrase'}); 1710: $phrasedata->{'related_words'} = \@NewWords; 1711: } 1712: push(@NewPhrases,$phrasedata); 1713: } 1714: # 1715: # Actually build the sql query from the phrases 1716: my $SQLQuery; 1717: foreach my $phrase (@NewPhrases) { 1718: my $query; 1719: if ($phrase->{'negate'}) { 1720: $query .= $field.' NOT LIKE "%'.$phrase->{'phrase'}.'%"'; 1721: } else { 1722: $query .= $field.' LIKE "%'.$phrase->{'phrase'}.'%"'; 1723: } 1724: foreach my $related (@{$phrase->{'related_words'}}) { 1725: if ($phrase->{'negate'}) { 1726: $query .= ' AND '.$field.' NOT LIKE "%'.$related.'%"'; 1727: } else { 1728: $query .= ' OR '.$field.' LIKE "%'.$related.'%"'; 1729: } 1730: } 1731: if ($SQLQuery) { 1732: if ($phrase->{'or'}) { 1733: $SQLQuery .= ' OR ('.$query.')'; 1734: } else { 1735: $SQLQuery .= ' AND ('.$query.')'; 1736: } 1737: } else { 1738: $SQLQuery = '('.$query.')'; 1739: } 1740: } 1741: # 1742: # &Apache::lonnet::logthis("SQLQuery = $SQLQuery"); 1743: # 1744: return undef,$SQLQuery; 1745: } 1746: 1747: ###################################################################### 1748: ###################################################################### 1749: 1750: =pod 1751: 1752: =item &related_version() 1753: 1754: Modifies an input string to include related words. Words in the string 1755: are replaced with parenthesized lists of 'OR'd words. For example 1756: "torque" is replaced with "(torque OR word1 OR word2 OR ...)". 1757: 1758: Note: Using this twice on a string is probably silly. 1759: 1760: =cut 1761: 1762: ###################################################################### 1763: ###################################################################### 1764: sub related_version { 1765: my ($word) = @_; 1766: return (undef) if (lc($word) =~ /\b(or|and|not)\b/); 1767: my @Words = &Apache::loncommon::get_related_words($word); 1768: # Only use 4 related words 1769: @Words = ($#Words>4? @Words[0..4] : @Words); 1770: my $result = join " OR ", ($word,@Words); 1771: return $result,sort(@Words); 1772: } 1773: 1774: 1775: ###################################################################### 1776: ###################################################################### 1777: 1778: =pod 1779: 1780: =item &build_custommetadata_query() 1781: 1782: Constructs a custom metadata query using a rather heinous regular 1783: expression. 1784: 1785: =cut 1786: 1787: ###################################################################### 1788: ###################################################################### 1789: sub build_custommetadata_query { 1790: my ($field_name,$logic_statement)=@_; 1791: my $q=new Text::Query('abc', 1792: -parse => 'Text::Query::ParseAdvanced', 1793: -build => 'Text::Query::BuildAdvancedString'); 1794: $q->prepare($logic_statement); 1795: my $matchexp=${$q}{'-parse'}{'-build'}{'matchstring'}; 1796: # quick fix to change literal into xml tag-matching 1797: # will eventually have to write a separate builder module 1798: # wordone=wordtwo becomes\<wordone\>[^\<] *wordtwo[^\<]*\<\/wordone\> 1799: $matchexp =~ s/(\w+)\\=([\w\\\+]+)?# wordone=wordtwo is changed to 1800: /\\<$1\\>?# \<wordone\> 1801: \[\^\\<\]?# [^\<] 1802: \*$2\[\^\\<\]?# *wordtwo[^\<] 1803: \*\\<\\\/$1\\>?# *\<\/wordone\> 1804: /g; 1805: return $matchexp; 1806: } 1807: 1808: 1809: ###################################################################### 1810: ###################################################################### 1811: 1812: =pod 1813: 1814: =item &build_date_queries() 1815: 1816: Builds a SQL logic query to check time/date entries. 1817: Also reports errors (check for /^Incorrect/). 1818: 1819: =cut 1820: 1821: ###################################################################### 1822: ###################################################################### 1823: sub build_date_queries { 1824: my ($cafter,$cbefore,$mafter,$mbefore) = @_; 1825: my ($result,$error,$pretty_string); 1826: # 1827: # Verify the input 1828: if (! defined($cafter) && ! defined($cbefore) && 1829: ! defined($mafter) && ! defined($mbefore)) { 1830: # This is an okay situation, so return undef for the error 1831: return (undef,undef,undef); 1832: } 1833: if ((defined($cafter) && ! defined($cbefore)) || 1834: (defined($cbefore) && ! defined($cafter))) { 1835: # This is bad, so let them know 1836: $error = &mt('Incorrect entry for the creation date. '. 1837: 'You must specify both the beginning and ending dates.'); 1838: } 1839: if (! defined($error) && 1840: ((defined($mafter) && ! defined($mbefore)) || 1841: (defined($mbefore) && ! defined($mafter)))) { 1842: # This is also bad, so let them know 1843: $error = &mt('Incorrect entry for the last revision date. '. 1844: 'You must specify both the beginning and ending dates.'); 1845: } 1846: if (! defined($error)) { 1847: # 1848: # Build the queries 1849: my @queries; 1850: if (defined($cbefore) && defined($cafter)) { 1851: my (undef,undef,undef,$caday,$camon,$cayear) = localtime($cafter); 1852: my (undef,undef,undef,$cbday,$cbmon,$cbyear) = localtime($cbefore); 1853: # Correct for year being relative to 1900 1854: $cayear+=1900; $cbyear+=1900; 1855: my $cquery= 1856: '(creationdate BETWEEN '. 1857: "'".$cayear.'-'.$camon.'-'.$caday."'". 1858: ' AND '. 1859: "'".$cbyear.'-'.$cbmon.'-'.$cbday." 23:59:59')"; 1860: $pretty_string .= '<br />' if (defined($pretty_string)); 1861: $pretty_string .= 1862: &mt('created between [_1] and [_2]', 1863: &Apache::lonlocal::locallocaltime($cafter), 1864: &Apache::lonlocal::locallocaltime($cbefore+24*60*60-1)); 1865: push(@queries,$cquery); 1866: $pretty_string =~ s/ 00:00:00//g; 1867: } 1868: if (defined($mbefore) && defined($mafter)) { 1869: my (undef,undef,undef,$maday,$mamon,$mayear) = localtime($mafter); 1870: my (undef,undef,undef,$mbday,$mbmon,$mbyear) = localtime($mbefore); 1871: # Correct for year being relative to 1900 1872: $mayear+=1900; $mbyear+=1900; 1873: my $mquery= 1874: '(lastrevisiondate BETWEEN '. 1875: "'".$mayear.'-'.$mamon.'-'.$maday."'". 1876: ' AND '. 1877: "'".$mbyear.'-'.$mbmon.'-'.$mbday." 23:59:59')"; 1878: push(@queries,$mquery); 1879: $pretty_string .= '<br />' if (defined($pretty_string)); 1880: $pretty_string .= 1881: &mt('last revised between [_1] and [_2]', 1882: &Apache::lonlocal::locallocaltime($mafter), 1883: &Apache::lonlocal::locallocaltime($mbefore+24*60*60-1)); 1884: $pretty_string =~ s/ 00:00:00//g; 1885: } 1886: if (@queries) { 1887: $result .= join(" AND ",@queries); 1888: } 1889: } 1890: return ($result,$error,$pretty_string); 1891: } 1892: 1893: ###################################################################### 1894: ###################################################################### 1895: 1896: =pod 1897: 1898: =item &copyright_check() 1899: 1900: Inputs: $Metadata, a hash pointer of metadata for a resource. 1901: 1902: Returns: 1 if the resource is available to the user making the query, 1903: 0 otherwise. 1904: 1905: =cut 1906: 1907: ###################################################################### 1908: ###################################################################### 1909: sub copyright_check { 1910: my $Metadata = shift; 1911: # Check copyright tags and skip results the user cannot use 1912: my (undef,undef,$resdom,$resname) = split('/', 1913: $Metadata->{'url'}); 1914: # Check for priv 1915: if ($Metadata->{'copyright'} eq 'priv') { 1916: unless (($env{'user.name'} eq $resname) && 1917: ($env{'user.domain'} eq $resdom)) { 1918: return 0; 1919: } 1920: } 1921: # Check for domain 1922: if (($Metadata->{'copyright'} eq 'domain') && 1923: ($env{'user.domain'} ne $resdom)) { 1924: return 0; 1925: } 1926: # Check for custom rights 1927: if ($Metadata->{'copyright'} eq 'custom') { 1928: return &Apache::lonnet::customaccess('bre',$Metadata->{'url'}); 1929: } 1930: return 1; 1931: } 1932: 1933: ###################################################################### 1934: ###################################################################### 1935: 1936: =pod 1937: 1938: =item &ensure_db_and_table() 1939: 1940: Ensure we can get lonmysql to connect to the database and the table we 1941: need exists. 1942: 1943: Inputs: $r, table id 1944: 1945: Returns: undef on error, 1 if the table exists. 1946: 1947: =cut 1948: 1949: ###################################################################### 1950: ###################################################################### 1951: sub ensure_db_and_table { 1952: my ($r,$table) = @_; 1953: ## 1954: ## Sanity check the table id. 1955: ## 1956: if (! defined($table) || $table eq '' || $table =~ /\D/ ) { 1957: $r->print(&Apache::loncommon::start_page('Error') 1958: .'<p class="LC_error">' 1959: .&mt('Unable to retrieve search results. ' 1960: .'Unable to determine the table results were saved in.') 1961: .'</p>' 1962: . '<p>'.&mt('Internal info:').'</p>' 1963: .'<pre>'.$table.'</pre>' 1964: .&Apache::loncommon::end_page() 1965: ); 1966: return undef; 1967: } 1968: ## 1969: ## Make sure we can connect and the table exists. 1970: ## 1971: my $connection_result = &Apache::lonmysql::connect_to_db(); 1972: if (!defined($connection_result)) { 1973: $r->print( 1974: '<p class="LC_error">' 1975: .&mt('Unable to connect to the MySQL database where your results are saved.') 1976: .'</p>' 1977: .&Apache::loncommon::end_page() 1978: ); 1979: &Apache::lonnet::logthis("lonsearchcat: unable to get lonmysql to". 1980: " connect to database."); 1981: &Apache::lonnet::logthis(&Apache::lonmysql::get_error()); 1982: return undef; 1983: } 1984: my $table_check = &Apache::lonmysql::check_table($table); 1985: if (! defined($table_check)) { 1986: $r->print( 1987: '<p class="LC_error">' 1988: .&mt('A MySQL error has occurred.') 1989: .'</p></form>' 1990: .&Apache::loncommon::end_page()); 1991: &Apache::lonnet::logthis("lonmysql was unable to determine the status". 1992: " of table ".$table); 1993: return undef; 1994: } elsif (! $table_check) { 1995: $r->print( 1996: '<p class="LC_error">' 1997: .&mt('The table of results could not be found.') 1998: .'</p>' 1999: ); 2000: &Apache::lonnet::logthis("The user requested a table, ".$table. 2001: ", that could not be found."); 2002: return undef; 2003: } 2004: return 1; 2005: } 2006: 2007: ###################################################################### 2008: ###################################################################### 2009: 2010: =pod 2011: 2012: =item &print_sort_form() 2013: 2014: The sort feature is not implemented at this time. This form just prints 2015: a link to change the search query. 2016: 2017: =cut 2018: 2019: ###################################################################### 2020: ###################################################################### 2021: sub print_sort_form { 2022: my ($r,$pretty_query_string) = @_; 2023: 2024: ## 2025: my %SortableFields=&Apache::lonlocal::texthash( 2026: id => 'Default', 2027: title => 'Title', 2028: author => 'Author', 2029: subject => 'Subject', 2030: url => 'URL', 2031: version => 'Version Number', 2032: mime => 'Mime type', 2033: lang => 'Language', 2034: owner => 'Owner/Publisher', 2035: copyright => 'Copyright', 2036: hostname => 'Host', 2037: creationdate => 'Creation Date', 2038: lastrevisiondate => 'Revision Date' 2039: ); 2040: ## 2041: my $table = $env{'form.table'}; 2042: return if (! &ensure_db_and_table($r,$table)); 2043: ## 2044: ## Get the number of results 2045: ## 2046: my $total_results = &Apache::lonmysql::number_of_rows($table); 2047: if (! defined($total_results)) { 2048: $r->print("A MySQL error has occurred.</form>". 2049: &Apache::loncommon::end_page()); 2050: &Apache::lonnet::logthis("lonmysql was unable to determine the number". 2051: " of rows in table ".$table); 2052: &Apache::lonnet::logthis(&Apache::lonmysql::get_error()); 2053: return; 2054: } 2055: my $start_page = &Apache::loncommon::start_page('Results',undef); 2056: my $breadcrumbs= 2057: &Apache::lonhtmlcommon::breadcrumbs('Searching','Searching', 2058: $env{'form.catalogmode'} ne 'import'); 2059: 2060: my $result = <<END; 2061: $start_page 2062: $breadcrumbs 2063: <form name="statusform" action="" method="post" target="_top"> 2064: <input type="hidden" name="catalogmode" value="import" /> 2065: <input type="hidden" name="acts" value="" /> 2066: END 2067: 2068: #<h2>Sort Results</h2> 2069: #Sort by: <select size="1" name="sortby" onchange="javascript:change_sort();"> 2070: # $env{'form.sortby'} = 'id' if (! defined($env{'form.sortby'})); 2071: # foreach (keys(%SortableFields)) { 2072: # $result.="<option name=\"$_\""; 2073: # if ($_ eq $env{'form.sortby'}) { 2074: # $result.=" selected "; 2075: # } 2076: # $result.=" >$SortableFields{$_}</option>\n"; 2077: # } 2078: # $result.="</select>\n"; 2079: my $revise = &revise_button(); 2080: $result.='<p>' 2081: .&mt('Total of [quant,_1,match,matches] to your query.',$total_results) 2082: .' '.$revise.'</p>' 2083: .'<p>'.&mt('Search: ').$pretty_query_string 2084: .'</p></form>'; 2085: $r->print($result.&Apache::loncommon::end_page()); 2086: return; 2087: } 2088: 2089: ##################################################################### 2090: ##################################################################### 2091: 2092: =pod 2093: 2094: =item MySQL Table Description 2095: 2096: MySQL table creation requires a precise description of the data to be 2097: stored. The use of the correct types to hold data is vital to efficient 2098: storage and quick retrieval of records. The columns must be described in 2099: the following format: 2100: 2101: =cut 2102: 2103: ##################################################################### 2104: ##################################################################### 2105: # 2106: # These should probably be scoped but I don't have time right now... 2107: # 2108: my @Datatypes; 2109: my @Fullindicies; 2110: 2111: ###################################################################### 2112: ###################################################################### 2113: 2114: =pod 2115: 2116: =item &create_results_table() 2117: 2118: Creates the table of search results by calling lonmysql. Stores the 2119: table id in $env{'form.table'} 2120: 2121: Inputs: search area - either res or portfolio 2122: 2123: Returns: the identifier of the table on success, undef on error. 2124: 2125: =cut 2126: 2127: ###################################################################### 2128: ###################################################################### 2129: sub set_up_table_structure { 2130: my ($tabletype) = @_; 2131: my ($datatypes,$fullindicies) = 2132: &LONCAPA::lonmetadata::describe_metadata_storage($tabletype); 2133: # Copy the table description before modifying it... 2134: @Datatypes = @{$datatypes}; 2135: unshift(@Datatypes,{name => 'id', 2136: type => 'MEDIUMINT', 2137: restrictions => 'UNSIGNED NOT NULL', 2138: primary_key => 'yes', 2139: auto_inc => 'yes' }); 2140: @Fullindicies = @{$fullindicies}; 2141: return; 2142: } 2143: 2144: sub create_results_table { 2145: my ($area) = @_; 2146: if ($area eq 'portfolio') { 2147: &set_up_table_structure('portfolio_search'); 2148: } else { 2149: &set_up_table_structure('metadata'); 2150: } 2151: my $table = &Apache::lonmysql::create_table 2152: ( { columns => \@Datatypes, 2153: FULLTEXT => [{'columns' => \@Fullindicies},], 2154: } ); 2155: if (defined($table)) { 2156: $env{'form.table'} = $table; 2157: return $table; 2158: } 2159: return undef; # Error... 2160: } 2161: 2162: ###################################################################### 2163: ###################################################################### 2164: 2165: =pod 2166: 2167: =item Search Status update functions 2168: 2169: Each of the following functions changes the values of one of the 2170: input fields used to display the search status to the user. The names 2171: should be explanatory. 2172: 2173: Inputs: Apache request handler ($r), text to display. 2174: 2175: Returns: Nothing. 2176: 2177: =over 4 2178: 2179: =item &update_count_status() 2180: 2181: =item &update_status() 2182: 2183: =item &update_seconds() 2184: 2185: =back 2186: 2187: =cut 2188: 2189: ###################################################################### 2190: ###################################################################### 2191: sub update_count_status { 2192: my ($r,$text) = @_; 2193: $text =~ s/\'/\\\'/g; 2194: $r->print(<<SCRIPT); 2195: <script type="text/javascript"> 2196: // <![CDATA[ 2197: document.statusform.count.value = ' $text' 2198: // ]]> 2199: </script> 2200: SCRIPT 2201: 2202: $r->rflush(); 2203: } 2204: 2205: sub update_status { 2206: my ($r,$text) = @_; 2207: $text =~ s/\'/\\\'/g; 2208: $r->print(<<SCRIPT); 2209: <script type="text/javascript"> 2210: // <![CDATA[ 2211: document.statusform.status.value = ' $text' 2212: // ]]> 2213: </script> 2214: SCRIPT 2215: 2216: $r->rflush(); 2217: } 2218: 2219: sub reload_result_frame { 2220: my ($r) = @_; 2221: my $newloc = '/adm/searchcat?phase=results&persistent_db_id='. 2222: $env{'form.persistent_db_id'}; 2223: $r->print(<<SCRIPT); 2224: <script type="text/javascript"> 2225: parent.update_results("$newloc"); 2226: </script> 2227: SCRIPT 2228: 2229: $r->rflush(); 2230: } 2231: 2232: { 2233: my $max_time = 60; # seconds for the search to complete 2234: my $start_time = 0; 2235: my $last_time = 0; 2236: 2237: sub reset_timing { 2238: $start_time = 0; 2239: $last_time = 0; 2240: } 2241: 2242: sub time_left { 2243: if ($start_time == 0) { 2244: $start_time = time; 2245: } 2246: my $time_left = $max_time - (time - $start_time); 2247: $time_left = 0 if ($time_left < 0); 2248: return $time_left; 2249: } 2250: 2251: sub update_seconds { 2252: my ($r) = @_; 2253: my $time = &time_left(); 2254: if (($last_time-$time) > 0) { 2255: $r->print(<<SCRIPT); 2256: <script type="text/javascript"> 2257: // <![CDATA[ 2258: document.statusform.seconds.value = '$time' 2259: // ]]> 2260: </script> 2261: SCRIPT 2262: 2263: $r->rflush(); 2264: } 2265: $last_time = $time; 2266: } 2267: 2268: } 2269: 2270: ###################################################################### 2271: ###################################################################### 2272: 2273: =pod 2274: 2275: =item &revise_button() 2276: 2277: Inputs: None 2278: 2279: Returns: html string for a 'revise search' button. 2280: 2281: =cut 2282: 2283: ###################################################################### 2284: ###################################################################### 2285: sub revise_button { 2286: my $revisetext = &mt('Revise search'); 2287: my $revise_phase = 'disp_basic'; 2288: $revise_phase = 'disp_adv' if ($env{'form.searchmode'} eq 'advanced'); 2289: my $newloc = '/adm/searchcat'. 2290: '?persistent_db_id='.$env{'form.persistent_db_id'}. 2291: '&cleargroupsort=1'. 2292: '&phase='.$revise_phase; 2293: my $result = qq{<input type="button" value="$revisetext" name="revise"} . 2294: qq{ onclick="parent.location='$newloc';" /> }; 2295: return $result; 2296: } 2297: 2298: ###################################################################### 2299: ###################################################################### 2300: 2301: =pod 2302: 2303: =item &run_search() 2304: 2305: Executes a search query by sending it the the other servers and putting the 2306: results into MySQL. 2307: 2308: =cut 2309: 2310: ###################################################################### 2311: ###################################################################### 2312: sub run_search { 2313: my ($r,$query,$customquery,$customshow,$serverlist, 2314: $pretty_string,$area,$domainsref) = @_; 2315: my $tabletype = 'metadata'; 2316: if ($area eq 'portfolio') { 2317: $tabletype = 'portfolio_search'; 2318: } 2319: my $connection = $r->connection; 2320: # 2321: # Print run_search header 2322: # 2323: my $start_page = &Apache::loncommon::start_page('Search Status',undef); 2324: my $breadcrumbs = 2325: &Apache::lonhtmlcommon::breadcrumbs('Searching','Searching', 2326: $env{'form.catalogmode'} ne 'import'); 2327: $r->print(<<END); 2328: $start_page 2329: $breadcrumbs 2330: END 2331: # Remove leading and trailing <br /> 2332: $pretty_string =~ s:^\s*<br />::i; 2333: $pretty_string =~ s:(<br />)*\s*$::im; 2334: my @Lines = split("<br />",$pretty_string); 2335: # I keep getting blank items at the end of the list, hence the following: 2336: while ($Lines[-1] =~ /^\s*$/ && @Lines) { 2337: pop(@Lines); 2338: } 2339: if (@Lines > 2) { 2340: $pretty_string = join '<br />',(@Lines[0..2],'...<br />'); 2341: } 2342: $r->print(&mt("Search: [_1]",$pretty_string)); 2343: $r->rflush(); 2344: # 2345: # Determine the servers we need to contact. 2346: my (@Servers_to_contact,%domains_by_server); 2347: if (defined($serverlist)) { 2348: if (ref($serverlist) eq 'ARRAY') { 2349: @Servers_to_contact = @$serverlist; 2350: } else { 2351: @Servers_to_contact = ($serverlist); 2352: } 2353: if (ref($domainsref) eq 'HASH') { 2354: foreach my $server (@Servers_to_contact) { 2355: $domains_by_server{$server} = $domainsref->{$server}; 2356: } 2357: } 2358: } else { 2359: my %library_servers = &Apache::lonnet::unique_library(); 2360: my (%all_library_servers, %older_library_servers); 2361: foreach my $key (keys(%library_servers)) { 2362: if (&Apache::lonnet::get_server_loncaparev('',$key) =~ /^\'?(\d+)\.(\d+)/) { 2363: my $major = $1; 2364: my $minor = $2; 2365: if (($major < 2) || (($major == 2) && ($minor < 11))) { 2366: map { $older_library_servers{$_} = 1; } 2367: &Apache::lonnet::machine_ids($library_servers{$key}); 2368: } 2369: } 2370: } 2371: %all_library_servers = (%library_servers,%older_library_servers); 2372: @Servers_to_contact = sort(keys(%all_library_servers)); 2373: foreach my $server (@Servers_to_contact) { 2374: my %possdoms; 2375: map { $possdoms{$_}=1; } &Apache::lonnet::machine_domains($all_library_servers{$server}); 2376: $domains_by_server{$server} = 2377: join(',',sort(&Apache::lonnet::machine_domains($all_library_servers{$server}))); 2378: } 2379: } 2380: my %Server_status; 2381: # 2382: # Check on the mysql table we will use to store results. 2383: my $table =$env{'form.table'}; 2384: if (! defined($table) || $table eq '' || $table =~ /\D/ ) { 2385: $r->print("Unable to determine table id to save search results in.". 2386: "The search has been aborted.". 2387: &Apache::loncommon::end_page()); 2388: return; 2389: } 2390: my $table_status = &Apache::lonmysql::check_table($table); 2391: if (! defined($table_status)) { 2392: $r->print("Unable to determine status of table.". 2393: &Apache::loncommon::end_page()); 2394: &Apache::lonnet::logthis("Bogus table id of $table for ". 2395: "$env{'user.name'} @ $env{'user.domain'}"); 2396: &Apache::lonnet::logthis("lonmysql error = ". 2397: &Apache::lonmysql::get_error()); 2398: return; 2399: } 2400: if (! $table_status) { 2401: &Apache::lonnet::logthis("lonmysql error = ". 2402: &Apache::lonmysql::get_error()); 2403: &Apache::lonnet::logthis("lonmysql debug = ". 2404: &Apache::lonmysql::get_debug()); 2405: &Apache::lonnet::logthis('table status = "'.$table_status.'"'); 2406: $r->print("The table id,$table, we tried to use is invalid.". 2407: "The search has been aborted.". 2408: &Apache::loncommon::end_page()); 2409: return; 2410: } 2411: ## 2412: ## Prepare for the big loop. 2413: my $hitcountsum; 2414: my $oldhitcountsum; 2415: my %matches; 2416: my $server; 2417: my $status; 2418: my $revise = &revise_button(); 2419: $r->print('<form name="statusform" action="" method="post">'."\n". 2420: '<input type="hidden" name="acts" value="" />'."\n". 2421: '<table border="0"><tr><td>'."\n". 2422: &Apache::loncommon::start_data_table()); 2423: $r->print(&Apache::loncommon::start_data_table_header_row() 2424: .'<th>'.&mt('Status').'</th>' 2425: .'<th>'.&mt('Total Matches').'</th>' 2426: .'<th>'.&mt('Time Remaining').'</th>' 2427: .&Apache::loncommon::end_data_table_header_row() 2428: .&Apache::loncommon::start_data_table_row() 2429: .'<td><input type="text" name="status" value="" size="50" readonly="readonly" /></td>' 2430: .'<td><input type="text" name="count" value="" size="10" readonly="readonly" /></td>' 2431: .'<td><input type="text" name="seconds" value="" size="8" readonly="readonly" /></td>' 2432: .&Apache::loncommon::end_data_table_row() 2433: .&Apache::loncommon::end_data_table() 2434: .'</td><td> </td><td>'.$revise.'</td></tr></table></form>'); 2435: $r->rflush(); 2436: &reset_timing(); 2437: &update_seconds($r); 2438: &update_status($r,&mt('contacting [_1]',$Servers_to_contact[0])); 2439: while (&time_left() && 2440: ((@Servers_to_contact) || keys(%Server_status))) { 2441: &update_seconds($r); 2442: # 2443: # Send out a search request 2444: if (@Servers_to_contact) { 2445: # Contact one server 2446: my $server = shift(@Servers_to_contact); 2447: &update_status($r,&mt('contacting [_1]',$server)); 2448: my $reply=&Apache::lonnet::metadata_query($query,$customquery, 2449: $customshow,[$server],\%domains_by_server); 2450: ($server) = keys(%$reply); 2451: $Server_status{$server} = $reply->{$server}; 2452: } else { 2453: # wait a sec. to give time for files to be written 2454: # This sleep statement is here instead of outside the else 2455: # block because we do not want to pause if we have servers 2456: # left to contact. 2457: if (scalar (keys(%Server_status))) { 2458: &update_status($r, 2459: &mt('waiting on [_1]',join(' ',keys(%Server_status)))); 2460: } 2461: sleep(0.1); 2462: } 2463: # 2464: # Loop through the servers we have contacted but do not 2465: # have results from yet, looking for results. 2466: foreach my $server (keys(%Server_status)) { 2467: last if ($connection->aborted()); 2468: &update_seconds($r); 2469: my $status = $Server_status{$server}; 2470: if ($status eq 'con_lost') { 2471: delete ($Server_status{$server}); 2472: next; 2473: } 2474: $status=~s|/||g; 2475: 2476: 2477: 2478: my $datafile=LONCAPA::tempdir().$status; 2479: if (-e $datafile && ! -e "$datafile.end") { 2480: &update_status($r,&mt('Receiving results from [_1]',$server)); 2481: next; 2482: } 2483: last if ($connection->aborted()); 2484: if (-e "$datafile.end") { 2485: &update_status($r,&mt('Reading results from [_1]',$server)); 2486: if (-z "$datafile") { 2487: delete($Server_status{$server}); 2488: next; 2489: } 2490: my $fh; 2491: if (!($fh=Apache::File->new($datafile))) { 2492: $r->print("Unable to open search results file for ". 2493: "server $server. Omitting from search"); 2494: delete($Server_status{$server}); 2495: next; 2496: } 2497: # Read in the whole file. 2498: while (my $result = <$fh>) { 2499: last if ($connection->aborted()); 2500: # 2501: # Records are stored one per line 2502: chomp($result); 2503: next if (! $result); 2504: # 2505: # Parse the result. 2506: my %Fields = &parse_raw_result($result,$server,$tabletype); 2507: $Fields{'hostname'} = $server; 2508: # 2509: # Skip based on copyright 2510: next if (! &copyright_check(\%Fields)); 2511: 2512: if ($area eq 'portfolio') { 2513: next if (defined($matches{$Fields{'url'}})); 2514: # Skip if inaccessible 2515: next if (!&Apache::lonnet::portfolio_access($Fields{'url'})); 2516: $matches{$Fields{'url'}} = 1; 2517: } 2518: # 2519: # Store the result in the mysql database 2520: my $result = &Apache::lonmysql::store_row($table,\%Fields); 2521: if (! defined($result)) { 2522: $r->print(&Apache::lonmysql::get_error()); 2523: } 2524: # 2525: $hitcountsum ++; 2526: &update_seconds($r); 2527: if ($hitcountsum % 50 == 0) { 2528: &update_count_status($r,$hitcountsum); 2529: } 2530: } 2531: $fh->close(); 2532: # $server is only deleted if the results file has been 2533: # found and (successfully) opened. This may be a bad idea. 2534: delete($Server_status{$server}); 2535: } 2536: last if ($connection->aborted()); 2537: if ($oldhitcountsum < $hitcountsum) { 2538: &update_count_status($r,$hitcountsum); 2539: if ($hitcountsum <= $env{'form.show'}) { 2540: reload_result_frame($r); 2541: } 2542: $oldhitcountsum = $hitcountsum; 2543: } 2544: } 2545: last if ($connection->aborted()); 2546: &update_seconds($r); 2547: } 2548: &update_status($r,&mt('Search Complete on Server [_1]',$server)); 2549: &update_seconds($r); 2550: # 2551: &Apache::lonmysql::disconnect_from_db(); # This is unneccessary 2552: # 2553: # We have run out of time or run out of servers to talk to and 2554: # results to get, so let the client know the top frame needs to be 2555: # loaded from /adm/searchcat 2556: $r->print(&Apache::loncommon::end_page()); 2557: # if ($env{'form.catalogmode'} ne 'import') { 2558: $r->print(<<SCRIPT); 2559: <script> 2560: window.location='/adm/searchcat?phase=sort&persistent_db_id=$env{'form.persistent_db_id'}'; 2561: </script> 2562: SCRIPT 2563: # } 2564: return; 2565: } 2566: 2567: ###################################################################### 2568: ###################################################################### 2569: 2570: =pod 2571: 2572: =item &prev_next_buttons() 2573: 2574: Returns html for the previous and next buttons on the search results page. 2575: 2576: =cut 2577: 2578: ###################################################################### 2579: ###################################################################### 2580: sub prev_next_buttons { 2581: my ($current_min,$show,$total,$parms) = @_; 2582: return '' if ($show eq 'all'); # No links if you get them all at once. 2583: # 2584: # Create buttons 2585: return '<p class="LC_nobreak">' 2586: .'<input type="submit" name="prev" value="<"' 2587: .' title="'.&mt('Previous').'" />' 2588: .' ' 2589: .'<input type="submit" name="reload" value="'.&mt('Reload').'" />' 2590: .' ' 2591: .'<input type="submit" name="next" value=">"' 2592: .' title="'.&mt('Next').'" />' 2593: .'</p>'; 2594: } 2595: 2596: ###################################################################### 2597: ###################################################################### 2598: 2599: =pod 2600: 2601: =item &display_results() 2602: 2603: Prints the results out for selection and perusal. 2604: 2605: =cut 2606: 2607: ###################################################################### 2608: ###################################################################### 2609: sub display_results { 2610: my ($r,$importbutton,$closebutton,$diropendb,$area) = @_; 2611: my $connection = $r->connection; 2612: $r->print(&search_results_header($importbutton,$closebutton)); 2613: ## 2614: ## Set viewing function 2615: ## 2616: my $viewfunction = $Views{$env{'form.viewselect'}}; 2617: if (!defined($viewfunction)) { 2618: $r->print('<p class="LC_error">' 2619: .&mt('Internal Error - Bad view selected.') 2620: .'</p>'."\n"); 2621: $r->rflush(); 2622: return; 2623: } 2624: ## 2625: ## $checkbox_num is a count of the number of checkboxes output on the 2626: ## page this is used only during catalogmode=import. 2627: my $checkbox_num = 0; 2628: ## 2629: ## Get the catalog controls setup 2630: ## 2631: my $action = "/adm/searchcat?phase=results"; 2632: ## 2633: ## Deal with import by opening the import db file. 2634: if ($env{'form.catalogmode'} eq 'import') { 2635: if (! tie(%groupsearch_db,'GDBM_File',$diropendb, 2636: &GDBM_WRCREAT(),0640)) { 2637: # NOTE: this can happen when a previous request to searchcat?phase=results gets interrupted 2638: # (%groupsearch_db is not untied) 2639: $r->print('<p class="LC_error">'. 2640: &mt('Unable to save import results.'). 2641: '</p>'. 2642: '</form>'. 2643: &Apache::loncommon::end_page()); 2644: $r->rflush(); 2645: return; 2646: } 2647: # untie %groupsearch_db if the connection gets aborted before the end 2648: $r->register_cleanup(sub { 2649: untie %groupsearch_db if (tied(%groupsearch_db)); 2650: }); 2651: } 2652: ## 2653: ## Prepare the table for querying 2654: my $table = $env{'form.table'}; 2655: return if (! &ensure_db_and_table($r,$table)); 2656: ## 2657: ## Get the number of results 2658: my $total_results = &Apache::lonmysql::number_of_rows($table); 2659: if (! defined($total_results)) { 2660: $r->print('<p class="LC_error">'. 2661: &mt('A MySQL error has occurred.'). 2662: '</p>'. 2663: '</form>'. 2664: &Apache::loncommon::end_page()); 2665: &Apache::lonnet::logthis("lonmysql was unable to determine the number". 2666: " of rows in table ".$table); 2667: &Apache::lonnet::logthis(&Apache::lonmysql::get_error()); 2668: return; 2669: } 2670: ## 2671: ## Determine how many results we need to get 2672: $env{'form.start'} = 1 if (! exists($env{'form.start'})); 2673: $env{'form.show'} = 20 if (! exists($env{'form.show'})); 2674: if (exists($env{'form.prev'})) { 2675: $env{'form.start'} -= $env{'form.show'}; 2676: } elsif (exists($env{'form.next'})) { 2677: $env{'form.start'} += $env{'form.show'}; 2678: } 2679: $env{'form.start'} = 1 if ($env{'form.start'}<1); 2680: $env{'form.start'} = $total_results if ($env{'form.start'}>$total_results); 2681: my $min = $env{'form.start'}; 2682: my $max; 2683: if ($env{'form.show'} eq 'all') { 2684: $max = $total_results ; 2685: } else { 2686: $max = $min + $env{'form.show'} - 1; 2687: $max = $total_results if ($max > $total_results); 2688: } 2689: ## 2690: ## Output form elements 2691: $r->print(&hidden_field('table'). 2692: &hidden_field('phase'). 2693: &hidden_field('persistent_db_id'). 2694: &hidden_field('start'). 2695: &hidden_field('area') 2696: ); 2697: # 2698: # Build sorting selector 2699: my @fields = 2700: ( 2701: {key=>'default' }, 2702: {key=>'title' }, 2703: {key =>'author' }, 2704: {key =>'subject'}, 2705: {key =>'url',desc=>'URL'}, 2706: {key =>'keywords'}, 2707: {key =>'language'}, 2708: {key =>'creationdate'}, 2709: {key =>'lastrevisiondate'}, 2710: {key =>'owner'}, 2711: {key =>'copyright'}, 2712: {key =>'authorspace'}, 2713: {key =>'lowestgradelevel'}, 2714: {key =>'highestgradelevel'}, 2715: {key =>'standards',desc=>'Standards'}, 2716: ); 2717: if ($area eq 'portfolio') { 2718: push(@fields, 2719: ( 2720: {key => 'scope'}, 2721: {key => 'keynum'}, 2722: )); 2723: } else { 2724: push(@fields, 2725: ( 2726: {key =>'count',desc=>'Number of accesses'}, 2727: {key =>'stdno',desc=>'Students Attempting'}, 2728: {key =>'avetries',desc=>'Average Number of Tries'}, 2729: {key =>'difficulty',desc=>'Mean Degree of Difficulty'}, 2730: {key =>'disc',desc=>'Mean Degree of Discrimination'}, 2731: {key =>'clear',desc=>'Evaluation: Clear'}, 2732: {key =>'technical',desc=>'Evaluation: Technically Correct'}, 2733: {key =>'correct',desc=>'Evaluation: Material is Correct'}, 2734: {key =>'helpful',desc=>'Evaluation: Material is Helpful'}, 2735: {key =>'depth',desc=>'Evaluation: Material has Depth'}, 2736: )); 2737: } 2738: my %fieldnames = &Apache::lonmeta::fieldnames(); 2739: my @field_order; 2740: foreach my $field_data (@fields) { 2741: push(@field_order,$field_data->{'key'}); 2742: if (! exists($field_data->{'desc'})) { 2743: $field_data->{'desc'}=$fieldnames{$field_data->{'key'}}; 2744: } else { 2745: if (! defined($field_data->{'desc'})) { 2746: $field_data->{'desc'} = ucfirst($field_data->{'key'}); 2747: } 2748: $field_data->{'desc'} = &mt($field_data->{'desc'}); 2749: } 2750: } 2751: my %sort_fields = map {$_->{'key'},$_->{'desc'}} @fields; 2752: $sort_fields{'select_form_order'} = \@field_order; 2753: $env{'form.sortorder'} = 'desc' if (! exists($env{'form.sortorder'})); 2754: if (! exists($env{'form.sortfield'})) { 2755: if ($area eq 'portfolio') { 2756: $env{'form.sortfield'} = 'owner'; 2757: } else { 2758: $env{'form.sortfield'} = 'count'; 2759: } 2760: } 2761: if (! exists($env{'form.sortorder'})) { 2762: if ($env{'form.sortfield'}=~/^(count|stdno|disc|clear|technical|correct|helpful)$/) { 2763: $env{'form.sortorder'}='desc'; 2764: } else { 2765: $env{'form.sortorder'}='asc'; 2766: } 2767: } 2768: my $sortform = '<span class="LC_nobreak">' 2769: .&mt('Sort by:').' ' 2770: .&Apache::loncommon::select_form($env{'form.sortfield'}, 2771: 'sortfield', 2772: \%sort_fields) 2773: .' ' 2774: .&Apache::loncommon::select_form($env{'form.sortorder'}, 2775: 'sortorder', 2776: {asc =>&mt('Ascending'), 2777: desc=>&mt('Descending') 2778: }) 2779: .'</span>'; 2780: ## 2781: ## Display links for 'prev' and 'next' pages (if necessary) and Display Options 2782: $r->print('<fieldset>'."\n" 2783: .'<legend>'.&mt('Display Options').'</legend>'."\n" 2784: .$sortform 2785: .' ' 2786: .&viewoptions() 2787: .'</fieldset>' 2788: .&prev_next_buttons($min,$env{'form.show'},$total_results) 2789: ); 2790: 2791: if ($total_results == 0) { 2792: $r->print('<p class="LC_info">'.&mt('There are currently no results.').'</p>'. 2793: "</form>". 2794: &Apache::loncommon::end_page()); 2795: return; 2796: } else { 2797: $r->print('<div>'. 2798: mt('Results [_1] to [_2] out of [_3]', 2799: $min,$max,$total_results). 2800: "</div>\n"); 2801: } 2802: ## 2803: ## Get results from MySQL table 2804: my $sort_command = 'id>='.$min.' AND id<='.$max; 2805: my $order; 2806: if (exists($env{'form.sortorder'})) { 2807: if ($env{'form.sortorder'} eq 'asc') { 2808: $order = 'ASC'; 2809: } elsif ($env{'form.sortorder'} eq 'desc') { 2810: $order = 'DESC'; 2811: } else { 2812: $order = ''; 2813: } 2814: } else { 2815: $order = ''; 2816: } 2817: if ($env{'form.sortfield'} ne 'default' && 2818: exists($sort_fields{$env{'form.sortfield'}})) { 2819: $sort_command = $env{'form.sortfield'}.' IS NOT NULL '. 2820: 'ORDER BY '.$env{'form.sortfield'}.' '.$order. 2821: ' LIMIT '.($min-1).','.($max-$min+1); 2822: } 2823: my @Results = &Apache::lonmysql::get_rows($table,$sort_command); 2824: ## 2825: ## Loop through the results and output them. 2826: my $tabletype = 'metadata'; 2827: if ($area eq 'portfolio') { 2828: $tabletype = 'portfolio_search'; 2829: } 2830: $r->print(&Apache::loncommon::start_data_table()); 2831: foreach my $row (@Results) { 2832: if ($connection->aborted()) { 2833: &cleanup(); 2834: return; 2835: } 2836: my %Fields = %{&parse_row($tabletype,@$row)}; 2837: my $output; 2838: if (! defined($Fields{'title'}) || $Fields{'title'} eq '') { 2839: $Fields{'title'} = 'Untitled'; 2840: } 2841: my $prefix=&catalogmode_output($Fields{'title'},$Fields{'url'}, 2842: $Fields{'id'},$checkbox_num++); 2843: # Render the result into html 2844: $output.= &$viewfunction($prefix,%Fields); 2845: # Print them out as they come in. 2846: $r->print(&Apache::loncommon::start_data_table_row() 2847: .'<td>' 2848: .$output 2849: .'</td>' 2850: .&Apache::loncommon::end_data_table_row() 2851: ); 2852: $r->rflush(); 2853: } 2854: $r->print(&Apache::loncommon::end_data_table()); 2855: if (@Results < 1) { 2856: $r->print('<p class="LC_info">' 2857: .&mt('There were no results matching your query.') 2858: .'</p>'); 2859: } else { 2860: $r->print( 2861: &prev_next_buttons($min,$env{'form.show'},$total_results, 2862: "table=".$env{'form.table'}. 2863: "&phase=results". 2864: "&persistent_db_id=". 2865: $env{'form.persistent_db_id'}) 2866: ); 2867: } 2868: $r->print("</form>".&Apache::loncommon::end_page()); 2869: $r->rflush(); 2870: untie %groupsearch_db if (tied(%groupsearch_db)); 2871: return; 2872: } 2873: 2874: ###################################################################### 2875: ###################################################################### 2876: 2877: =pod 2878: 2879: =item &catalogmode_output($title,$url,$fnum,$checkbox_num) 2880: 2881: Returns html needed for the various catalog modes. Gets inputs from 2882: $env{'form.catalogmode'}. Stores data in %groupsearch_db. 2883: 2884: =cut 2885: 2886: ###################################################################### 2887: ###################################################################### 2888: sub catalogmode_output { 2889: my $output = ''; 2890: my ($title,$url,$fnum,$checkbox_num) = @_; 2891: if ($env{'form.catalogmode'} eq 'interactive') { 2892: $title=~ s/\'/\\\'/g; 2893: if ($env{'form.catalogmode'} eq 'interactive') { 2894: $output.=<<END 2895: <font size='-1'><input type="button" name="returnvalues" value="select" 2896: onclick="javascript:select_data('$title','$url')" /> 2897: </font> 2898: END 2899: } 2900: } elsif ($env{'form.catalogmode'} eq 'import') { 2901: $groupsearch_db{"pre_${fnum}_link"}=$url; 2902: $groupsearch_db{"pre_${fnum}_title"}=$title; 2903: $output.=<<END; 2904: <font size='-1'> 2905: <input type="checkbox" name="returnvalues" value="select" 2906: onclick="javascript:queue($checkbox_num,$fnum)" /> 2907: </font> 2908: END 2909: } 2910: return $output; 2911: } 2912: ###################################################################### 2913: ###################################################################### 2914: 2915: =pod 2916: 2917: =item &parse_row() 2918: 2919: Parse a row returned from the database. 2920: 2921: =cut 2922: 2923: ###################################################################### 2924: ###################################################################### 2925: sub parse_row { 2926: my ($tabletype,@Row) = @_; 2927: my %Fields; 2928: if (! scalar(@Datatypes)) { 2929: &set_up_table_structure($tabletype); 2930: } 2931: for (my $i=0;$i<=$#Row;$i++) { 2932: $Fields{$Datatypes[$i]->{'name'}}=&unescape($Row[$i]); 2933: } 2934: $Fields{'language'} = 2935: &Apache::loncommon::languagedescription($Fields{'language'}); 2936: $Fields{'copyrighttag'} = 2937: &Apache::loncommon::copyrightdescription($Fields{'copyright'}); 2938: $Fields{'mimetag'} = 2939: &Apache::loncommon::filedescription($Fields{'mime'}); 2940: return \%Fields; 2941: } 2942: 2943: ########################################################### 2944: ########################################################### 2945: 2946: =pod 2947: 2948: =item &parse_raw_result() 2949: 2950: Takes a line from the file of results and parse it. Returns a hash 2951: with keys according to column labels 2952: 2953: In addition, the following tags are set by calling the appropriate 2954: lonnet function: 'language', 'copyrighttag', 'mimetag'. 2955: 2956: The 'title' field is set to "Untitled" if the title field is blank. 2957: 2958: 'abstract' and 'keywords' are truncated to 200 characters. 2959: 2960: =cut 2961: 2962: ########################################################### 2963: ########################################################### 2964: sub parse_raw_result { 2965: my ($result,$hostname,$tabletype) = @_; 2966: # conclude from self to others regarding fields 2967: my %Fields=&LONCAPA::lonmetadata::metadata_col_to_hash 2968: ($tabletype, 2969: map { 2970: &unescape($_); 2971: } (split(/\,/,$result)) ); 2972: return %Fields; 2973: } 2974: 2975: ########################################################### 2976: ########################################################### 2977: 2978: =pod 2979: 2980: =item &handle_custom_fields() 2981: 2982: =cut 2983: 2984: ########################################################### 2985: ########################################################### 2986: sub handle_custom_fields { 2987: my @results = @{shift()}; 2988: my $customshow=''; 2989: my $extrashow=''; 2990: my @customfields; 2991: if ($env{'form.customshow'}) { 2992: $customshow=$env{'form.customshow'}; 2993: $customshow=~s/[^\w\s]//g; 2994: my @fields=map { 2995: "<font color=\"#008000\">$_:</font>"; 2996: } split(/\s+/,$customshow); 2997: @customfields=split(/\s+/,$customshow); 2998: if ($customshow) { 2999: $extrashow="<ul><li>".join("</li><li>",@fields)."</li></ul>\n"; 3000: } 3001: } 3002: my $customdata=''; 3003: my %customhash; 3004: foreach my $result (@results) { 3005: if ($result=~/^(custom\=.*)$/) { # grab all custom metadata 3006: my $tmp=$result; 3007: $tmp=~s/^custom\=//; 3008: my ($k,$v)=map {&unescape($_); 3009: } split(/\,/,$tmp); 3010: $customhash{$k}=$v; 3011: } 3012: } 3013: return ($extrashow,\@customfields,\%customhash); 3014: } 3015: 3016: ###################################################################### 3017: ###################################################################### 3018: 3019: =pod 3020: 3021: =item &search_results_header() 3022: 3023: Output the proper html headers and javascript code to deal with different 3024: calling modes. 3025: 3026: Takes most inputs directly from %env, except $mode. 3027: 3028: =over 4 3029: 3030: =item $mode is either (at this writing) 'Basic' or 'Advanced' 3031: 3032: =back 3033: 3034: The following environment variables are checked: 3035: 3036: =over 4 3037: 3038: =item 'form.catalogmode' 3039: 3040: Checked for 'interactive' and 'import'. 3041: 3042: =item 'form.mode' 3043: 3044: Checked for existance & 'edit' mode. 3045: 3046: =item 'form.form' 3047: 3048: Contains the name of the form that has the input fields to set 3049: 3050: =item 'form.element' 3051: 3052: the name of the input field to put the URL into 3053: 3054: =item 'form.titleelement' 3055: 3056: the name of the input field to put the title into 3057: 3058: =back 3059: 3060: =cut 3061: 3062: ###################################################################### 3063: ###################################################################### 3064: sub search_results_header { 3065: my ($importbutton,$closebutton) = @_; 3066: 3067: my $js; 3068: # output beginning of search page 3069: # conditional output of script functions dependent on the mode in 3070: # which the search was invoked 3071: if ($env{'form.catalogmode'} eq 'interactive'){ 3072: if (! exists($env{'form.mode'}) || $env{'form.mode'} ne 'edit') { 3073: $js.=<<SCRIPT; 3074: <script type="text/javascript"> 3075: // <![CDATA[ 3076: function select_data(title,url) { 3077: changeTitle(title); 3078: changeURL(url); 3079: parent.close(); 3080: } 3081: function changeTitle(val) { 3082: if (parent.opener.inf.document.forms.resinfo.elements.t) { 3083: parent.opener.inf.document.forms.resinfo.elements.t.value=val; 3084: } 3085: } 3086: function changeURL(val) { 3087: if (parent.opener.inf.document.forms.resinfo.elements.u) { 3088: parent.opener.inf.document.forms.resinfo.elements.u.value=val; 3089: } 3090: } 3091: // ]]> 3092: </script> 3093: SCRIPT 3094: } elsif ($env{'form.mode'} eq 'edit') { 3095: my $form = $env{'form.form'}; 3096: my $element = $env{'form.element'}; 3097: my $titleelement = $env{'form.titleelement'}; 3098: my $changetitle; 3099: if (!$titleelement) { 3100: $changetitle='function changeTitle(val) {}'; 3101: } else { 3102: $changetitle=<<END; 3103: function changeTitle(val) { 3104: if (parent.targetwin.document) { 3105: parent.targetwin.document.forms["$form"].elements["$titleelement"].value=val; 3106: } else { 3107: var url = 'forms[\"$form\"].elements[\"$titleelement\"].value'; 3108: alert("Unable to transfer data to "+url); 3109: } 3110: } 3111: END 3112: } 3113: 3114: $js.=<<SCRIPT; 3115: <script type="text/javascript"> 3116: // <![CDATA[ 3117: function select_data(title,url) { 3118: changeURL(url); 3119: changeTitle(title); 3120: parent.close(); 3121: } 3122: $changetitle 3123: function changeURL(val) { 3124: if (parent.targetwin.document) { 3125: parent.targetwin.document.forms["$form"].elements["$element"].value=val; 3126: } else { 3127: var url = 'forms[\"$form\"].elements[\"$element\"].value'; 3128: alert("Unable to transfer data to "+url); 3129: } 3130: } 3131: // ]]> 3132: </script> 3133: SCRIPT 3134: } 3135: } 3136: my $inhibit_menu = "&".&Apache::loncommon::inhibit_menu_check(); 3137: $js.=<<SCRIPT if $env{'form.catalogmode'} eq 'import'; 3138: <script type="text/javascript"> 3139: // <![CDATA[ 3140: function queue(checkbox_num,val) { 3141: if (document.forms.results.returnvalues.length != "undefined" && 3142: typeof(document.forms.results.returnvalues.length) == "number") { 3143: if (document.forms.results.returnvalues[checkbox_num].checked) { 3144: parent.statusframe.document.forms.statusform.elements.acts.value +='1a'+val+'b'; 3145: } else { 3146: parent.statusframe.document.forms.statusform.elements.acts.value +='0a'+val+'b'; 3147: } 3148: } else { 3149: if (document.forms.results.returnvalues.checked) { 3150: parent.statusframe.document.forms.statusform.elements.acts.value +='1a'+val+'b'; 3151: } else { 3152: parent.statusframe.document.forms.statusform.elements.acts.value +='0a'+val+'b'; 3153: } 3154: } 3155: } 3156: function select_group() { 3157: parent.window.location= 3158: "/adm/groupsort?mode=$env{'form.mode'}&catalogmode=import$inhibit_menu&acts="+ 3159: parent.statusframe.document.forms.statusform.elements.acts.value; 3160: } 3161: // ]]> 3162: </script> 3163: SCRIPT 3164: 3165: $js.=<<SCRIPT; 3166: <script type="text/javascript"> 3167: \$(document).ready(function() { 3168: parent.done_loading_results(); 3169: }); 3170: </script> 3171: SCRIPT 3172: 3173: my $start_page = &Apache::loncommon::start_page(undef,$js, 3174: {'only_body' =>1, 3175: 'add_wishlist' =>1, 3176: 'add_modal' =>1}); 3177: my $result=<<END; 3178: $start_page 3179: <form name="results" method="post" action="/adm/searchcat"> 3180: $importbutton 3181: END 3182: return $result; 3183: } 3184: 3185: sub results_link { 3186: my $basic_link = "/adm/searchcat?"."&table=".$env{'form.table'}. 3187: "&persistent_db_id=".$env{'form.persistent_db_id'}; 3188: my $results_link = $basic_link."&phase=results". 3189: "&pause=1"."&start=1"; 3190: return $results_link; 3191: } 3192: 3193: ###################################################################### 3194: ###################################################################### 3195: sub print_frames_interface { 3196: my $r = shift; 3197: my $basic_link = "/adm/searchcat?"."&table=".$env{'form.table'}. 3198: "&persistent_db_id=".$env{'form.persistent_db_id'}; 3199: my $run_search_link = $basic_link."&phase=run_search"; 3200: my $results_link = &results_link(); 3201: my $js = <<JS; 3202: <script type="text/javascript"> 3203: var targetwin = opener; 3204: var queue = ''; 3205: 3206: var loading_results = true; 3207: var need_reloading = false; 3208: var new_location; 3209: function update_results(newloc) { 3210: if (loading_results) { 3211: need_reloading = true; 3212: new_location = newloc; 3213: } else { 3214: loading_results = true; 3215: resultsframe.location = newloc; 3216: } 3217: } 3218: function done_loading_results() { 3219: loading_results = false; 3220: if (need_reloading) { 3221: need_reloading = false; 3222: update_results(new_location); 3223: } 3224: } 3225: </script> 3226: JS 3227: 3228: my $start_page = 3229: &Apache::loncommon::start_page('LON-CAPA Digital Library Search Results', 3230: $js, 3231: {'frameset' => 1, 3232: 'add_entries' => { 3233: 'rows' => "150,*",},}); 3234: my $end_page = 3235: &Apache::loncommon::end_page({'frameset' => 1}); 3236: 3237: my $result = <<"ENDFRAMES"; 3238: $start_page 3239: <frame name="statusframe" src="$run_search_link"> 3240: <frame name="resultsframe" src="$results_link"> 3241: $end_page 3242: ENDFRAMES 3243: 3244: $r->print($result); 3245: return; 3246: } 3247: 3248: ###################################################################### 3249: ###################################################################### 3250: 3251: sub has_stat_data { 3252: my ($values) = @_; 3253: if ( (defined($values->{'count'}) && $values->{'count'} ne '') || 3254: (defined($values->{'stdno'}) && $values->{'stdno'} ne '') || 3255: (defined($values->{'disc'}) && $values->{'disc'} ne '') || 3256: (defined($values->{'avetries'}) && $values->{'avetries'} ne '') || 3257: (defined($values->{'difficulty'}) && $values->{'difficulty'} ne '')) { 3258: return 1; 3259: } 3260: return 0; 3261: } 3262: 3263: sub statfields { 3264: return ('count','stdno','disc','avetries','difficulty'); 3265: } 3266: 3267: sub has_eval_data { 3268: my ($values) = @_; 3269: if ( (defined($values->{'clear'}) && $values->{'clear'} ne '') || 3270: (defined($values->{'technical'}) && $values->{'technical'} ne '') || 3271: (defined($values->{'correct'}) && $values->{'correct'} ne '') || 3272: (defined($values->{'helpful'}) && $values->{'helpful'} ne '') || 3273: (defined($values->{'depth'}) && $values->{'depth'} ne '')) { 3274: return 1; 3275: } 3276: return 0; 3277: } 3278: 3279: sub evalfields { 3280: return ('clear','technical','correct','helpful','depth'); 3281: } 3282: 3283: ###################################################################### 3284: ###################################################################### 3285: 3286: sub display_tools { 3287: my ($title, $jumpurl) = @_; 3288: my $result; 3289: # Metadata 3290: $result.= 3291: &Apache::loncommon::modal_link( 3292: $jumpurl.'.meta?inhibitmenu=yes', 3293: '<img class="LC_icon" src="/res/adm/pages/catalog.png" alt="Info" />', 3294: 500,500,'_blank',undef,&mt('Metadata')); 3295: # Stored Links 3296: $result.= 3297: ' <a href="javascript:;"'. 3298: ' onclick="set_wishlistlink('."'$title','$jumpurl'".')" '. 3299: 'title="'.&mt('Save a link for this resource in your personal Stored Links repository').'">'. 3300: '<img class="LC_icon" src="/res/adm/pages/wishlist.png" '. 3301: 'alt="Stored Links" style="width:22px;"/></a>'; 3302: return $result; 3303: } 3304: 3305: ###################################################################### 3306: ###################################################################### 3307: 3308: =pod 3309: 3310: =item Metadata Viewing Functions 3311: 3312: Output is a HTML-ified string. 3313: 3314: Input arguments are title, author, subject, url, keywords, version, 3315: notes, short abstract, mime, language, creation date, 3316: last revision date, owner, copyright, hostname, and 3317: extra custom metadata to show. 3318: 3319: =over 4 3320: 3321: =item &detailed_citation_view() 3322: 3323: =cut 3324: 3325: ###################################################################### 3326: ###################################################################### 3327: sub detailed_citation_view { 3328: my ($prefix,%values) = @_; 3329: my $result; 3330: my $jumpurl=$values{'url'}; 3331: $jumpurl=~s|^/ext/|http://|; 3332: $result .= 3333: '<b>'.$prefix. 3334: '<img src="'.&Apache::loncommon::icon($values{'url'}).'" alt="" />'.' '. 3335: '<a href="'.$jumpurl.'?inhibitmenu=yes" '. 3336: 'target="preview" onclick="openMyModal(this.href, 500, 500, \'yes\');return false;">'.$values{'title'}."</a></b>\n". 3337: &display_tools($values{'title'}, $jumpurl). 3338: "<p>\n". 3339: '<b>'.$values{'author'}.'</b>,'. 3340: ' <i>'.$values{'owner'}.'</i><br />'; 3341: foreach my $field 3342: ( 3343: { name=>'url', 3344: translate => '<b>URL:</b> [_1]', 3345: special => 'url link',}, 3346: { name=>'subject', 3347: translate => '<b>Subject:</b> [_1]',}, 3348: { name=>'keywords', 3349: translate => '<b>Keywords:</b> [_1]',}, 3350: { name=>'notes', 3351: translate => '<b>Notes:</b> [_1]',}, 3352: { name=>'mimetag', 3353: translate => '<b>MIME Type:</b> [_1]',}, 3354: { name=>'standards', 3355: translate => '<b>Standards:</b>[_1]',}, 3356: { name=>'copyrighttag', 3357: translate => '<b>Copyright/Distribution:</b> [_1]',}, 3358: { name=>'count', 3359: format => "%d", 3360: translate => '<b>Access Count:</b> [_1]',}, 3361: { name=>'stdno', 3362: format => "%d", 3363: translate => '<b>Number of Students:</b> [_1]',}, 3364: { name=>'avetries', 3365: format => "%.2f", 3366: translate => '<b>Average Tries:</b> [_1]',}, 3367: { name=>'disc', 3368: format => "%.2f", 3369: translate => '<b>Degree of Discrimination:</b> [_1]',}, 3370: { name=>'difficulty', 3371: format => "%.2f", 3372: translate => '<b>Degree of Difficulty:</b> [_1]',}, 3373: { name=>'clear', 3374: format => "%.2f", 3375: translate => '<b>Clear:</b> [_1]',}, 3376: { name=>'depth', 3377: format => "%.2f", 3378: translate => '<b>Depth:</b> [_1]',}, 3379: { name=>'helpful', 3380: format => "%.2f", 3381: translate => '<b>Helpful:</b> [_1]',}, 3382: { name=>'correct', 3383: format => "%.2f", 3384: translate => '<b>Correct:</b> [_1]',}, 3385: { name=>'technical', 3386: format => "%.2f", 3387: translate => '<b>Technical:</b> [_1]',}, 3388: { name=>'comefrom_list', 3389: type => 'list', 3390: translate => 'Resources that lead up to this resource in maps',}, 3391: { name=>'goto_list', 3392: type => 'list', 3393: translate => 'Resources that follow this resource in maps',}, 3394: { name=>'sequsage_list', 3395: type => 'list', 3396: translate => 'Resources using or importing resource',}, 3397: ) { 3398: next if (! exists($values{$field->{'name'}}) || 3399: $values{$field->{'name'}} eq ''); 3400: if (exists($field->{'type'}) && $field->{'type'} eq 'list') { 3401: $result .= '<b>'.&mt($field->{'translate'}).'</b>'; 3402: foreach my $item (split(',',$values{$field->{'name'}})){ 3403: $item = &Apache::lonnet::clutter($item); 3404: $result .= '<br />'.&display_url($item,1).'<br />'; 3405: } 3406: } elsif (exists($field->{'format'}) && $field->{'format'} ne ''){ 3407: $result.= &mt($field->{'translate'}, 3408: sprintf($field->{'format'}, 3409: $values{$field->{'name'}}))."<br />\n"; 3410: } else { 3411: if ($field->{'special'} eq 'url link') { 3412: $result .= '<br />'.&display_url($jumpurl,1).'<br />'; 3413: } else { 3414: $result.= &mt($field->{'translate'}, 3415: $values{$field->{'name'}}); 3416: } 3417: $result .= "<br />\n"; 3418: } 3419: } 3420: $result .= "</p>"; 3421: if (exists($values{'extrashow'}) && $values{'extrashow'} ne '') { 3422: $result .= '<p>'.$values{'extrashow'}.'</p>'; 3423: } 3424: if (exists($values{'shortabstract'}) && $values{'shortabstract'} ne '') { 3425: $result .= '<p>'.$values{'shortabstract'}.'</p>'; 3426: } 3427: return $result; 3428: } 3429: 3430: sub detailed_citation_preview { 3431: my ($prefix,%values)=@_; 3432: return &detailed_citation_view($prefix,%values). 3433: '</td><td>'. 3434: &Apache::lonindexer::showpreview($values{'url'}); 3435: } 3436: 3437: 3438: ###################################################################### 3439: ###################################################################### 3440: 3441: =pod 3442: 3443: =item &summary_view() 3444: 3445: =cut 3446: ###################################################################### 3447: ###################################################################### 3448: sub summary_view { 3449: my ($prefix,%values) = @_; 3450: my $icon=&Apache::loncommon::icon($values{'url'}); 3451: my $result=qq{$prefix<img src="$icon" alt="" />}; 3452: if (exists($env{'form.sortfield'}) && 3453: $env{'form.sortfield'} !~ /^(default| 3454: author| 3455: url| 3456: title| 3457: owner| 3458: lastrevisiondate| 3459: copyright)$/x) { 3460: my $tmp = $values{$env{'form.sortfield'}}; 3461: if (! defined($tmp)) { $tmp = 'undefined'; } 3462: $result .= ' '.$tmp.' '; 3463: } 3464: my $jumpurl=$values{'url'}; 3465: $jumpurl=~s|^/ext/|http://|; 3466: my $link = '<br />'.&display_url($jumpurl,1).'<br />'; 3467: $result .= 3468: '<a href="'.$jumpurl.'?inhibitmenu=yes"'. 3469: ' target="preview" onclick="openMyModal(this.href, 500, 500, \'yes\');return false;">'.$values{'title'}.'</a>'. 3470: &display_tools($values{'title'}, $jumpurl).<<END; 3471: <br /> 3472: $link<br /> 3473: $values{'author'}, $values{'owner'} -- $values{'lastrevisiondate'}<br /> 3474: $values{'copyrighttag'}<br /> 3475: $values{'extrashow'} 3476: END 3477: return $result; 3478: } 3479: 3480: sub summary_preview { 3481: my ($prefix,%values)=@_; 3482: return &summary_view($prefix,%values). 3483: '</td><td>'. 3484: &Apache::lonindexer::showpreview($values{'url'}); 3485: } 3486: 3487: ###################################################################### 3488: ###################################################################### 3489: 3490: =pod 3491: 3492: =item &compact_view() 3493: 3494: =cut 3495: 3496: ###################################################################### 3497: ###################################################################### 3498: sub compact_view { 3499: my ($prefix,%values) = @_; 3500: my $jumpurl=$values{'url'}; 3501: $jumpurl=~s|^/ext/|http://|; 3502: 3503: my $link = &display_url($jumpurl,1); 3504: 3505: my $result = 3506: $prefix.'<img src="'.&Apache::loncommon::icon($values{'url'}).'" alt="" />'; 3507: if (exists($env{'form.sortfield'}) && 3508: $env{'form.sortfield'} !~ /^(default|author|url|title)$/) { 3509: my $tmp = $values{$env{'form.sortfield'}}; 3510: if (! defined($tmp)) { $tmp = 'undefined'; } 3511: $result .= ' '.$tmp.' '; 3512: } 3513: $jumpurl = &HTML::Entities::encode($jumpurl,'<>&"'); 3514: $result.=' <span class="LC_nobreak">'. 3515: '<a href="'.$jumpurl.'?inhibitmenu=yes" target="preview" onclick="openMyModal(this.href, 500, 500, \'yes\');return false;">'. 3516: &HTML::Entities::encode($values{'title'},'<>&"').'</a></span> '. 3517: &display_tools($values{'title'}, $jumpurl). 3518: $link.' <b>'.$values{'author'}.'</b> ('.$values{'domain'}.')'; 3519: return $result; 3520: } 3521: 3522: sub display_url { 3523: my ($url,$skiplast) = @_; 3524: my $link; 3525: if ($url=~m|^/ext/|) { 3526: $url=~s|^/ext/|http://|; 3527: $link='<span class="LC_filename">'.$url.'</span>'; 3528: } elsif ($url=~m{^(http://|/uploaded/)}) { 3529: $link='<span class="LC_filename">'.$url.'</span>'; 3530: } else { 3531: $link=&Apache::lonhtmlcommon::crumbs( 3532: $url, 3533: 'preview', 3534: '', 3535: '', 3536: $skiplast).' '; 3537: # replace the links to open in a new window 3538: # (because the search opens in a new window, it gets 3539: # confusing when the links open a tab in the 3540: # parent window; ideally we should not force windows) 3541: $link =~ s/(href="[^"]*")/\1 onclick="window.open(this.href, '_blank', 'toolbar=1,location=1,menubar=0');return false;"/g; 3542: } 3543: return $link; 3544: } 3545: 3546: ###################################################################### 3547: ###################################################################### 3548: 3549: =pod 3550: 3551: =item &fielded_format_view() 3552: 3553: =cut 3554: 3555: ###################################################################### 3556: ###################################################################### 3557: sub fielded_format_view { 3558: my ($prefix,%values) = @_; 3559: my $icon=&Apache::loncommon::icon($values{'url'}); 3560: my %Translated = &Apache::lonmeta::fieldnames(); 3561: my $jumpurl=$values{'url'}; 3562: $jumpurl=~s|^/ext/|http://|; 3563: 3564: my $result=<<END; 3565: $prefix <img src="$icon" alt="" /> 3566: <dl> 3567: <dt>URL:</dt> 3568: <dd><a href="$jumpurl?inhibitmenu=yes" 3569: target='preview'>$values{'url'}</a> 3570: END 3571: $result .= 3572: &display_tools($values{'title'}, $jumpurl).' 3573: </dd>'; 3574: foreach my $field ('title','author','domain','subject','keywords','notes', 3575: 'mimetag','language','creationdate','lastrevisiondate', 3576: 'owner','copyrighttag','hostname','abstract') { 3577: $result .= (' 'x4).'<dt>'.$Translated{$field}.'</dt>'."\n". 3578: (' 'x8).'<dd>'.$values{$field}.'</dd>'."\n"; 3579: } 3580: if (&has_stat_data(\%values)) { 3581: foreach my $field (&statfields()) { 3582: $result .= (' 'x4).'<dt>'.$Translated{$field}.'</dt>'."\n". 3583: (' 'x8).'<dd>'.$values{$field}.'</dd>'."\n"; 3584: } 3585: } 3586: if (&has_eval_data(\%values)) { 3587: foreach my $field (&evalfields()) { 3588: $result .= (' 'x4).'<dt>'.$Translated{$field}.'</dt>'."\n". 3589: (' 'x8).'<dd>'.$values{$field}.'</dd>'."\n"; 3590: } 3591: } 3592: $result .= "</dl>\n"; 3593: $result .= $values{'extrashow'}; 3594: return $result; 3595: } 3596: 3597: ###################################################################### 3598: ###################################################################### 3599: 3600: =pod 3601: 3602: =item &xml_sgml_view() 3603: 3604: =back 3605: 3606: =cut 3607: 3608: ###################################################################### 3609: ###################################################################### 3610: sub xml_sgml_view { 3611: my ($prefix,%values) = @_; 3612: my $xml = '<LonCapaResource>'."\n"; 3613: # The usual suspects 3614: foreach my $field ('url','title','author','subject','keywords','notes','domain') { 3615: $xml .= qq{<$field>$values{$field}</$field>}."\n"; 3616: } 3617: # 3618: $xml .= "<mimeInfo>\n"; 3619: foreach my $field ('mime','mimetag') { 3620: $xml .= qq{<$field>$values{$field}</$field>}."\n"; 3621: } 3622: $xml .= "</mimeInfo>\n"; 3623: # 3624: $xml .= "<languageInfo>\n"; 3625: foreach my $field ('language','languagetag') { 3626: $xml .= qq{<$field>$values{$field}</$field>}."\n"; 3627: } 3628: $xml .= "</languageInfo>\n"; 3629: # 3630: foreach my $field ('creationdate','lastrevisiondate','owner') { 3631: $xml .= qq{<$field>$values{$field}</$field>}."\n"; 3632: } 3633: # 3634: $xml .= "<copyrightInfo>\n"; 3635: foreach my $field ('copyright','copyrighttag') { 3636: $xml .= qq{<$field>$values{$field}</$field>}."\n"; 3637: } 3638: $xml .= "</copyrightInfo>\n"; 3639: $xml .= qq{<repositoryLocation>$values{'hostname'}</repositoryLocation>}. 3640: "\n"; 3641: $xml .= qq{<shortabstract>$values{'shortabstract'}</shortabstract>}."\n"; 3642: # 3643: if (&has_stat_data(\%values)){ 3644: $xml .= "<problemstatistics>\n"; 3645: foreach my $field (&statfields()) { 3646: $xml .= qq{<$field>$values{$field}</$field>}."\n"; 3647: } 3648: $xml .= "</problemstatistics>\n"; 3649: } 3650: # 3651: if (&has_eval_data(\%values)) { 3652: $xml .= "<evaluation>\n"; 3653: foreach my $field (&evalfields) { 3654: $xml .= qq{<$field>$values{$field}</$field>}."\n"; 3655: } 3656: $xml .= "</evaluation>\n"; 3657: } 3658: # 3659: $xml .= "</LonCapaResource>\n"; 3660: $xml = &HTML::Entities::encode($xml,'<>&'); 3661: my $result=<<END; 3662: $prefix 3663: <pre> 3664: $xml 3665: </pre> 3666: $values{'extrashow'} 3667: END 3668: return $result; 3669: } 3670: 3671: ###################################################################### 3672: ###################################################################### 3673: 3674: =pod 3675: 3676: =item &filled() see if field is filled. 3677: 3678: =cut 3679: 3680: ###################################################################### 3681: ###################################################################### 3682: sub filled { 3683: my ($field)=@_; 3684: if ($field=~/\S/ && $field ne 'any') { 3685: return 1; 3686: } else { 3687: return 0; 3688: } 3689: } 3690: 3691: ###################################################################### 3692: ###################################################################### 3693: 3694: =pod 3695: 3696: =item &output_unparsed_phrase_error() 3697: 3698: =cut 3699: 3700: ###################################################################### 3701: ###################################################################### 3702: sub output_unparsed_phrase_error { 3703: my ($r,$closebutton,$parms,$hidden_fields,$field)=@_; 3704: my $errorstring; 3705: if ($field eq 'basicexp') { 3706: $errorstring = &mt('Unable to understand the search phrase [_1]. Please modify your search.' 3707: ,'<i>'.$env{'form.basicexp'}.'</i>'); 3708: } else { 3709: $errorstring = &mt('Unable to understand the search phrase [_1]: [_2]' 3710: ,'<i>'.$field.'</i>' 3711: ,$env{'form.'.$field}); 3712: } 3713: my $heading = &mt('Unparsed Field'); 3714: my $revise = &mt('Revise search request'); 3715: # make query information persistent to allow for subsequent revision 3716: my $start_page = &Apache::loncommon::start_page('Search'); 3717: my $end_page = &Apache::loncommon::end_page(); 3718: $r->print(<<ENDPAGE); 3719: $start_page 3720: <form method="post" action="/adm/searchcat"> 3721: $hidden_fields 3722: $closebutton 3723: <hr /> 3724: <h2>$heading</h2> 3725: <p class="LC_warning"> 3726: $errorstring 3727: </p> 3728: <p> 3729: <a href="/adm/searchcat?$parms&persistent_db_id=$env{'form.persistent_db_id'}">$revise</a> 3730: </p> 3731: $end_page 3732: ENDPAGE 3733: } 3734: 3735: ###################################################################### 3736: ###################################################################### 3737: 3738: =pod 3739: 3740: =item &output_blank_field_error() 3741: 3742: Output a complete page that indicates the user has not filled in enough 3743: information to do a search. 3744: 3745: Inputs: $r (Apache request handle), $closebutton, $parms. 3746: 3747: Returns: nothing 3748: 3749: $parms is extra information to include in the 'Revise search request' link. 3750: 3751: =cut 3752: 3753: ###################################################################### 3754: ###################################################################### 3755: sub output_blank_field_error { 3756: my ($r,$closebutton,$parms,$hidden_fields)=@_; 3757: my $errormsg = &mt('You did not fill in enough information for the search to be started. You need to fill in relevant fields on the search page in order for a query to be processed.'); 3758: my $revise = &mt('Revise Search Request'); 3759: my $heading = &mt('Unactionable Search Query'); 3760: my $start_page = &Apache::loncommon::start_page('Search'); 3761: my $end_page = &Apache::loncommon::end_page(); 3762: if ($closebutton) { 3763: $closebutton = '<p>'.$closebutton.'</p><hr />'; 3764: } else { 3765: &Apache::lonhtmlcommon::add_breadcrumb 3766: ({href=>'', 3767: text=>$heading,}); 3768: $start_page .= &Apache::lonhtmlcommon::breadcrumbs(); 3769: } 3770: 3771: $r->print(<<ENDPAGE); 3772: $start_page 3773: <form method="post" action="/adm/searchcat"> 3774: $hidden_fields 3775: $closebutton 3776: </form> 3777: <h2>$heading</h2> 3778: <p class="LC_warning"> 3779: $errormsg 3780: </p> 3781: <p> 3782: <a href="/adm/searchcat?$parms&persistent_db_id=$env{'form.persistent_db_id'}">$revise</a> 3783: </p> 3784: $end_page 3785: ENDPAGE 3786: return; 3787: } 3788: 3789: ###################################################################### 3790: ###################################################################### 3791: 3792: =pod 3793: 3794: =item &output_date_error() 3795: 3796: Output a full html page with an error message. 3797: 3798: Inputs: 3799: 3800: $r, the request pointer. 3801: $message, the error message for the user. 3802: $closebutton, the specialized close button needed for groupsearch. 3803: 3804: =cut 3805: 3806: ###################################################################### 3807: ###################################################################### 3808: sub output_date_error { 3809: my ($r,$message,$closebutton,$hidden_fields)=@_; 3810: # make query information persistent to allow for subsequent revision 3811: my $start_page = &Apache::loncommon::start_page('Search'); 3812: my $end_page = &Apache::loncommon::end_page(); 3813: my $heading = &mt('Error'); 3814: $r->print(<<RESULTS); 3815: $start_page 3816: <form method="post" action="/adm/searchcat"> 3817: $hidden_fields 3818: <input type='button' value='Revise search request' 3819: onclick='this.form.submit();' /> 3820: $closebutton 3821: </form> 3822: <hr /> 3823: <h3>$heading</h3> 3824: <p class="LC_error"> 3825: $message 3826: </p> 3827: $end_page 3828: RESULTS 3829: } 3830: 3831: ###################################################################### 3832: ###################################################################### 3833: 3834: =pod 3835: 3836: =item &start_fresh_session() 3837: 3838: Cleans the global %groupsearch_db by removing all fields which begin with 3839: 'pre_' or 'store'. 3840: 3841: =cut 3842: 3843: ###################################################################### 3844: ###################################################################### 3845: sub start_fresh_session { 3846: delete $groupsearch_db{'mode_catalog'}; 3847: foreach (keys(%groupsearch_db)) { 3848: if ($_ =~ /^pre_/) { 3849: delete $groupsearch_db{$_}; 3850: } 3851: if ($_ =~ /^store/) { 3852: delete $groupsearch_db{$_}; 3853: } 3854: } 3855: } 3856: 3857: 1; 3858: 3859: sub cleanup { 3860: if (tied(%groupsearch_db)) { 3861: unless (untie(%groupsearch_db)) { 3862: &Apache::lonnet::logthis('Failed cleanup searchcat: groupsearch_db'); 3863: } 3864: } 3865: &Apache::lonmysql::disconnect_from_db(); 3866: return OK; 3867: } 3868: 3869: __END__ 3870: 3871: =pod 3872: 3873: =back 3874: 3875: =cut