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