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