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