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