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