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