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