1: # The LearningOnline Network
2: # Search Catalog
3: #
4: # 03/08/2001 Scott Harrison
5: # Scott Harrison: 03/12/2001, 03/13/2001, 03/14/2001, 03/15/2001, 03/19/2001
6: # Scott Harrison: 03/20/2001, 03/21/2001, 03/22/2001, 03/26/2001, 03/27/2001
7: # Scott Harrison: 04/02/2001
8: #
9: # Functions
10: #
11: # handler(server reference) : interacts with the Apache server layer
12: # (for /adm/searchcat URLs)
13: # simpletextfield(name,value) : returns HTML formatted string for simple text
14: # field
15: # simplecheckbox(name,value) : returns HTML formatted string for simple
16: # checkbox
17: # searchphrasefield(title,name,value) : returns HTML formatted string for
18: # a search expression phrase field
19: # dateboxes(name, defaultmonth, defaultday, defaultyear) : returns HTML
20: # formatted string
21: # for a calendar date
22: # selectbox(title,name,value,%HASH=options) : returns HTML formatted string for
23: # a selection box field
24: # advancedsearch(server reference, environment reference) : perform a complex
25: # multi-field logical query
26: # filled(field) : determines whether a given field has been filled
27: # basicsearch(server reference, environment reference) : perform a simple
28: # single-field logical query
29: # output_blank_field_error(server reference) : outputs a message saying that
30: # more fields need to be filled in
31: # output_results(output mode,
32: # server reference,
33: # environment reference,
34: # reply list reference) : outputs results from search
35: # build_SQL_query(field name, logic) : builds a SQL query string from a
36: # logical expression with AND/OR keywords
37: # recursive_SQL_query_build(field name, reverse notation expression) :
38: # builds a SQL query string from a reverse notation expression
39: # logical expression with AND/OR keywords
40: # build_custommetadata_query(field_name, logic_statement) : builds a perl
41: # regular expression from a logical expression with AND/OR
42: # keywords
43: # detailed_citation_view, summary_view, fielded_format_view, xml_sgml_view:
44: # four different ways to view metadata records. Outputs a HTML-ified string.
45: # Input arguments are title, author, subject, url, keywords, version, notes,
46: # short abstract, mime, language, creation date, last revision date, owner,
47: # copyright, hostname, httphost, and extra custom metadata to show.
48: # build_date_queries(cmonth1, cday1, cyear1, cmonth2, cday2, cyear2,
49: # lmonth1, lday1, lyear1, lmonth2, lday2, lyear2) :
50: # Builds a SQL logic query to check time/date entries.
51: # output_date_error(server reference, error message) : outputs
52: # an error message specific to bad date format.
53: # make_persistent() : makes a set of hidden HTML fields to make
54: # SQL search interface information to be persistent
55:
56: package Apache::lonsearchcat;
57:
58: use strict;
59: use Apache::Constants qw(:common);
60: use Apache::lonnet();
61: use Apache::File();
62: use CGI qw(:standard);
63: use Text::Query;
64:
65: # ---------------------------------------- variables used throughout the module
66: my %language;
67: my $scrout;
68: my %metadatafields;
69: my %cprtag;
70: my %mimetag;
71: my $closebutton;
72:
73: # ------ form selection elements that allow for choosing different output views
74: # Detailed Citation View ---> sub detailed_citationview
75: # Summary View ---> sub summary_view
76: # Fielded Format ---> sub fielded_format_view
77: # XML/SGML ---> sub xml_sgml_view
78: my $basicviewselect=<<END;
79: <select name='basicviewselect'>
80: <option value='Detailed Citation View'>Detailed Citation View</option>
81: <option value='Summary View'>Summary View</option>
82: <option value='Fielded Format'>Fielded Format</option>
83: <option value='XML/SGML'>XML/SGML</option>
84: </select>
85: END
86: my $advancedviewselect=<<END;
87: <select name='advancedviewselect'>
88: <option value='Detailed Citation View'>Detailed Citation View</option>
89: <option value='Summary View'>Summary View</option>
90: <option value='Fielded Format'>Fielded Format</option>
91: <option value='XML/SGML'>XML/SGML</option>
92: </select>
93: END
94:
95: # ----------------------------- Handling routine called via Apache and mod_perl
96: sub handler {
97: my $r = shift;
98:
99: # -------------------------------------- see if called from an interactive mode
100: map {
101: my ($name, $value) = split(/=/,$_);
102: $value =~ tr/+/ /;
103: $value =~ s/%([a-fA-F0-9][a-fA-F0-9])/pack("C",hex($1))/eg;
104: if ($name eq 'catalogmode') {
105: $ENV{'form.'.$name}=$value;
106: }
107: } (split(/&/,$ENV{'QUERY_STRING'}));
108:
109: $r->content_type('text/html');
110: $r->send_http_header;
111: return OK if $r->header_only;
112:
113: %metadatafields=();
114:
115: my $hidden='';
116: if ($ENV{'form.catalogmode'} eq 'interactive') {
117: $hidden=<<END;
118: <input type='hidden' name='catalogmode' value='interactive'>
119: END
120: $closebutton=<<END;
121: <input type="button" name="close" value='CLOSE' onClick="self.close()">
122: END
123: }
124:
125: # ------------------------------------------------ First, check out environment
126: $metadatafields{'owner'}=$ENV{'user.name'}.'@'.$ENV{'user.domain'};
127:
128: # --------------------------------- Compute various listings of metadata values
129:
130: %language=();
131: $language{'any'}='Any language';
132: {
133: my $fh=Apache::File->new($r->dir_config('lonTabDir').'/language.tab');
134: map {
135: $_=~/(\w+)\s+([\w\s\-]+)/; chomp;
136: $language{$1}=$2;
137: } <$fh>;
138: }
139:
140: %cprtag=();
141: $cprtag{'any'}='Any copyright/distribution';
142: {
143: my $fh=Apache::File->new($r->dir_config('lonIncludes').'/copyright.tab');
144: map {
145: $_=~/(\w+)\s+([\w\s\-]+)/; chomp;
146: $cprtag{$1}=$2;
147: } <$fh>;
148: }
149:
150: %mimetag=();
151: $mimetag{'any'}='Any type';
152: {
153: my $fh=Apache::File->new($r->dir_config('lonTabDir').'/filetypes.tab');
154: map {
155: $_=~/(\w+)\s+(\w+)\s+([\w\s\-]+)/; chomp;
156: $mimetag{$1}=".$1 $3";
157: } <$fh>;
158: }
159:
160: # ----------------------------------- See if a search invocation should be done
161: if ($ENV{'form.basicsubmit'} eq 'SEARCH') {
162: return &basicsearch($r,\%ENV);
163: }
164: elsif ($ENV{'form.advancedsubmit'} eq 'SEARCH') {
165: return &advancedsearch($r,\%ENV);
166: }
167:
168: # ----------------------------- Else, begin building search interface to output
169: $scrout=''; # building a part of screen output
170: $scrout.=&searchphrasefield('Limit by title','title',
171: $ENV{'form.title'});
172:
173: $scrout.=&searchphrasefield('Limit by author','author',
174: $ENV{'form.author'});
175:
176: $scrout.=&searchphrasefield('Limit by subject','subject',
177: $ENV{'form.subject'});
178:
179: $scrout.=&searchphrasefield('Limit by keywords','keywords',
180: $ENV{'form.keywords'});
181:
182: $scrout.=&searchphrasefield('Limit by URL','url',
183: $ENV{'form.url'});
184:
185: $scrout.=&searchphrasefield('Limit by version','version',
186: $ENV{'form.version'});
187:
188: $scrout.=&searchphrasefield('Limit by notes','notes',
189: $ENV{'form.notes'});
190:
191: $scrout.=&searchphrasefield('Limit by abstract','abstract',
192: $ENV{'form.abstract'});
193:
194: $ENV{'form.mime'}='notxxx' unless length($ENV{'form.mime'});
195: $scrout.=&selectbox('Limit by MIME type','mime',
196: $ENV{'form.mime'},%mimetag);
197:
198: $ENV{'form.language'}='any' unless length($ENV{'form.language'});
199:
200: $scrout.=&selectbox('Limit by language','language',
201: $ENV{'form.language'},%language);
202:
203:
204: # ------------------------------------------------ Compute date selection boxes
205: $scrout.=<<CREATIONDATESTART;
206: <p>
207: <font color="#800000" face="helvetica"><b>LIMIT BY CREATION DATE RANGE:</b>
208: </font>
209: <br>
210: between:
211: CREATIONDATESTART
212: $scrout.=&dateboxes('creationdatestart',1,1,1976,
213: $ENV{'form.creationdatestart_month'},
214: $ENV{'form.creationdatestart_day'},
215: $ENV{'form.creationdatestart_year'},
216: );
217: $scrout.=<<CREATIONDATEEND;
218: and:
219: CREATIONDATEEND
220: $scrout.=&dateboxes('creationdateend',12,31,2051,
221: $ENV{'form.creationdateend_month'},
222: $ENV{'form.creationdateend_day'},
223: $ENV{'form.creationdateend_year'},
224: );
225: $scrout.="</p>";
226:
227: $scrout.=<<LASTREVISIONDATESTART;
228: <p>
229: <font color="#800000" face="helvetica"><b>LIMIT BY LAST REVISION DATE RANGE:
230: </b></font>
231: <br>between:
232: LASTREVISIONDATESTART
233: $scrout.=&dateboxes('lastrevisiondatestart',1,1,1976,
234: $ENV{'form.lastrevisiondatestart_month'},
235: $ENV{'form.lastrevisiondatestart_day'},
236: $ENV{'form.lastrevisiondatestart_year'},
237: );
238: $scrout.=<<LASTREVISIONDATEEND;
239: and:
240: LASTREVISIONDATEEND
241: $scrout.=&dateboxes('lastrevisiondateend',12,31,2051,
242: $ENV{'form.lastrevisiondateend_month'},
243: $ENV{'form.lastrevisiondateend_day'},
244: $ENV{'form.lastrevisiondateend_year'},
245: );
246: $scrout.='</p>';
247:
248: $scrout.=&searchphrasefield('Limit by publisher/owner','owner',
249: $ENV{'form.owner'});
250: # $metadatafields{'owner'});
251:
252: $ENV{'form.copyright'}='any' unless length($ENV{'form.copyright'});
253: $scrout.=&selectbox('Limit by copyright/distribution','copyright',
254: $ENV{'form.copyright'},%cprtag);
255:
256: # ------------------------------------------- Compute customized metadata field
257: $scrout.=<<CUSTOMMETADATA;
258: <p>
259: <font color="#800000" face="helvetica"><b>LIMIT BY SPECIAL METADATA FIELDS:</b>
260: </font>
261: For resource-specific metadata, enter in an expression in the form of
262: <i>key</i>=<i>value</i> separated by operators such as AND or OR.<br>
263: <b>Example:</b> grandmother=75 OR grandfather=85
264: <br>
265: CUSTOMMETADATA
266: $scrout.=&simpletextfield('custommetadata',$ENV{'form.custommetadata'});
267: $scrout.=' <i>initial users of this system do not need to worry about this option</i>';
268:
269: $scrout.=<<CUSTOMSHOW;
270: <p>
271: <font color="#800000" face="helvetica"><b>SHOW SPECIAL METADATA FIELDS:</b>
272: </font>
273: Enter in a space-separated list of special metadata fields to show
274: in a fielded listing for each record result.
275: <br>
276: CUSTOMSHOW
277: $scrout.=&simpletextfield('customshow',$ENV{'form.customshow'});
278: $scrout.=' <i>initial users of this system do not need to worry about this option</i>';
279:
280: # ---------------------------------------------------------------- Print screen
281: $r->print(<<ENDDOCUMENT);
282: <html>
283: <head>
284: <title>The LearningOnline Network with CAPA</title>
285: </head>
286: <body bgcolor="#FFFFFF">
287: <img align=right src=/adm/lonIcons/lonlogos.gif>
288: <h1>Search Catalog</h1>
289: <form method="post" action="/adm/searchcat">
290: $hidden
291: <hr>
292: <h3>Basic Search</h3>
293: <p>
294: Enter terms or phrases separated by search operators
295: such as AND or OR then press SEARCH below. Terms should be specific
296: to the title, author, subject, notes, or abstract information associated
297: with a resource.
298: <br>
299: ENDDOCUMENT
300: $r->print(&simpletextfield('basicexp',$ENV{'form.basicexp'}));
301: $r->print(' ');
302: $r->print(&simplecheckbox('titleonly',$ENV{'form.titleonly'}));
303: $r->print('<font color="#800000">Title only</font> ');
304: $r->print(&simplecheckbox('allversions',$ENV{'form.allversions'}));
305: $r->print(<<ENDDOCUMENT);
306: <font color="#800000">Search historic archives</font>
307: <br>
308: <input type="submit" name="basicsubmit" value='SEARCH' />
309: <input type="reset" name="reset" value='RESET' />
310: $closebutton
311: $basicviewselect
312: </p>
313: <hr>
314: <h3>Advanced Search</h3>
315: $scrout
316: <p>
317: <input type="submit" name="advancedsubmit" value='SEARCH' />
318: <input type="reset" name="reset" value='RESET' />
319: $closebutton
320: $advancedviewselect
321: </p>
322: </form>
323: </body>
324: </html>
325: ENDDOCUMENT
326: return OK;
327: }
328:
329: # --------------------------------------------------------- Various form fields
330:
331: sub simpletextfield {
332: my ($name,$value)=@_;
333: return '<input type=text name=\''.$name.
334: '\' size=20 value=\''.$value.'\' />';
335: }
336:
337: sub simplecheckbox {
338: my ($name,$value)=@_;
339: my $checked='';
340: $checked="CHECKED" if $value eq 'on';
341: return '<input type=checkbox name=\''.$name.'\' '. $checked . '>';
342: }
343:
344: sub searchphrasefield {
345: my ($title,$name,$value)=@_;
346: my $instruction=<<END;
347: Enter terms or phrases separated by search operators such
348: as AND or OR.
349: END
350: my $uctitle=uc($title);
351: return "\n<p><font color=\"#800000\" face=\"helvetica\"><b>$uctitle:</b>".
352: "</FONT> $instruction<br>".
353: '<input type=text name="'.$name.'" size=80 value=\''.$value.'\'>';
354: }
355:
356: sub dateboxes {
357: my ($name,$defaultmonth,$defaultday,$defaultyear,
358: $currentmonth,$currentday,$currentyear)=@_;
359: ($defaultmonth,$defaultday,$defaultyear)=('','','');
360: my $month=<<END;
361: <select name="${name}_month">
362: <option value='$defaultmonth'> </option>
363: <option value="1">January</option>
364: <option value="2">February</option>
365: <option value="3">March</option>
366: <option value="4">April</option>
367: <option value="5">May</option>
368: <option value="6">June</option>
369: <option value="7">July</option>
370: <option value="8">August</option>
371: <option value="9">September</option>
372: <option value="10">October</option>
373: <option value="11">November</option>
374: <option value="12">December</option>
375: </select>
376: END
377: $month=~s/(\"$currentmonth\")/$1 SELECTED/ if length($currentmonth);
378: my $day=<<END;
379: <select name="${name}_day">
380: <option value='$defaultday'> </option>
381: <option value="1">1</option>
382: <option value="2">2</option>
383: <option value="3">3</option>
384: <option value="4">4</option>
385: <option value="5">5</option>
386: <option value="6">6</option>
387: <option value="7">7</option>
388: <option value="8">8</option>
389: <option value="9">9</option>
390: <option value="10">10</option>
391: <option value="11">11</option>
392: <option value="12">12</option>
393: <option value="13">13</option>
394: <option value="14">14</option>
395: <option value="15">15</option>
396: <option value="16">16</option>
397: <option value="17">17</option>
398: <option value="18">18</option>
399: <option value="19">19</option>
400: <option value="20">20</option>
401: <option value="21">21</option>
402: <option value="22">22</option>
403: <option value="23">23</option>
404: <option value="24">24</option>
405: <option value="25">25</option>
406: <option value="26">26</option>
407: <option value="27">27</option>
408: <option value="28">28</option>
409: <option value="29">29</option>
410: <option value="30">30</option>
411: <option value="31">31</option>
412: </select>
413: END
414: $day=~s/(\"$currentday\")/$1 SELECTED/ if length($currentday);
415: my $year=<<END;
416: <select name="${name}_year">
417: <option value='$defaultyear'> </option>
418: <option value="1976">1976</option>
419: <option value="1977">1977</option>
420: <option value="1978">1978</option>
421: <option value="1979">1979</option>
422: <option value="1980">1980</option>
423: <option value="1981">1981</option>
424: <option value="1982">1982</option>
425: <option value="1983">1983</option>
426: <option value="1984">1984</option>
427: <option value="1985">1985</option>
428: <option value="1986">1986</option>
429: <option value="1987">1987</option>
430: <option value="1988">1988</option>
431: <option value="1989">1989</option>
432: <option value="1990">1990</option>
433: <option value="1991">1991</option>
434: <option value="1992">1992</option>
435: <option value="1993">1993</option>
436: <option value="1994">1994</option>
437: <option value="1995">1995</option>
438: <option value="1996">1996</option>
439: <option value="1997">1997</option>
440: <option value="1998">1998</option>
441: <option value="1999">1999</option>
442: <option value="2000">2000</option>
443: <option value="2001">2001</option>
444: <option value="2002">2002</option>
445: <option value="2003">2003</option>
446: <option value="2004">2004</option>
447: <option value="2005">2005</option>
448: <option value="2006">2006</option>
449: <option value="2007">2007</option>
450: <option value="2008">2008</option>
451: <option value="2009">2009</option>
452: <option value="2010">2010</option>
453: <option value="2011">2011</option>
454: <option value="2012">2012</option>
455: <option value="2013">2013</option>
456: <option value="2014">2014</option>
457: <option value="2015">2015</option>
458: <option value="2016">2016</option>
459: <option value="2017">2017</option>
460: <option value="2018">2018</option>
461: <option value="2019">2019</option>
462: <option value="2020">2020</option>
463: <option value="2021">2021</option>
464: <option value="2022">2022</option>
465: <option value="2023">2023</option>
466: <option value="2024">2024</option>
467: <option value="2025">2025</option>
468: <option value="2026">2026</option>
469: <option value="2027">2027</option>
470: <option value="2028">2028</option>
471: <option value="2029">2029</option>
472: <option value="2030">2030</option>
473: <option value="2031">2031</option>
474: <option value="2032">2032</option>
475: <option value="2033">2033</option>
476: <option value="2034">2034</option>
477: <option value="2035">2035</option>
478: <option value="2036">2036</option>
479: <option value="2037">2037</option>
480: <option value="2038">2038</option>
481: <option value="2039">2039</option>
482: <option value="2040">2040</option>
483: <option value="2041">2041</option>
484: <option value="2042">2042</option>
485: <option value="2043">2043</option>
486: <option value="2044">2044</option>
487: <option value="2045">2045</option>
488: <option value="2046">2046</option>
489: <option value="2047">2047</option>
490: <option value="2048">2048</option>
491: <option value="2049">2049</option>
492: <option value="2050">2050</option>
493: <option value="2051">2051</option>
494: </select>
495: END
496: $year=~s/(\"$currentyear\")/$1 SELECTED/ if length($currentyear);
497: return "$month$day$year";
498: }
499:
500: sub selectbox {
501: my ($title,$name,$value,%options)=@_;
502: my $uctitle=uc($title);
503: my $selout="\n<p><font color=\"#800000\" face=\"helvetica\"><b>$uctitle:".
504: "</b></font><br>".'<select name="'.$name.'">';
505: map {
506: $selout.='<option value=\''.$_.'\'';
507: if ($_ eq $value) { $selout.=' selected'; }
508: $selout.='>'.$options{$_}.'</option>';
509: } sort keys %options;
510: return $selout.'</select>';
511: }
512:
513: # ----------------------------------------------- Performing an advanced search
514: sub advancedsearch {
515: my ($r,$envhash)=@_;
516: my %ENV=%{$envhash};
517:
518: my $fillflag=0;
519: # Clean up fields for safety
520: for my $field ('title','author','subject','keywords','url','version',
521: 'creationdatestart_month','creationdatestart_day',
522: 'creationdatestart_year','creationdateend_month',
523: 'creationdateend_day','creationdateend_year',
524: 'lastrevisiondatestart_month','lastrevisiondatestart_day',
525: 'lastrevisiondatestart_year','lastrevisiondateend_month',
526: 'lastrevisiondateend_day','lastrevisiondateend_year',
527: 'notes','abstract','mime','language','owner',
528: 'custommetadata','customshow') {
529: $ENV{"form.$field"}=~s/[^\w\s\(\)\=\-\"\']//g;
530: }
531:
532: # Check to see if enough information was filled in
533: for my $field ('title','author','subject','keywords','url','version',
534: 'notes','abstract','mime','language','owner',
535: 'custommetadata') {
536: if (&filled($ENV{"form.$field"})) {
537: $fillflag++;
538: }
539: }
540: unless ($fillflag) {
541: &output_blank_field_error($r);
542: return OK;
543: }
544:
545:
546: # Turn the form input into a SQL-based query
547: my $query='';
548:
549: my @queries;
550: # Evaluate logical expression AND/OR/NOT phrase fields.
551: foreach my $field ('title','author','subject','notes','abstract','url',
552: 'keywords','version','owner') {
553: if ($ENV{'form.'.$field}) {
554: push @queries,&build_SQL_query($field,$ENV{'form.'.$field});
555: }
556: }
557: # Evaluate option lists
558: if ($ENV{'form.language'} and $ENV{'form.language'} ne 'any') {
559: push @queries,"(language like \"$ENV{'form.language'}\")";
560: }
561: if ($ENV{'form.mime'} and $ENV{'form.mime'} ne 'any') {
562: push @queries,"(mime like \"$ENV{'form.mime'}\")";
563: }
564: if ($ENV{'form.copyright'} and $ENV{'form.copyright'} ne 'any') {
565: push @queries,"(copyright like \"$ENV{'form.copyright'}\")";
566: }
567: # Evaluate date windows
568: my $datequery=&build_date_queries(
569: $ENV{'form.creationdatestart_month'},
570: $ENV{'form.creationdatestart_day'},
571: $ENV{'form.creationdatestart_year'},
572: $ENV{'form.creationdateend_month'},
573: $ENV{'form.creationdateend_day'},
574: $ENV{'form.creationdateend_year'},
575: $ENV{'form.lastrevisiondatestart_month'},
576: $ENV{'form.lastrevisiondatestart_day'},
577: $ENV{'form.lastrevisiondatestart_year'},
578: $ENV{'form.lastrevisiondateend_month'},
579: $ENV{'form.lastrevisiondateend_day'},
580: $ENV{'form.lastrevisiondateend_year'},
581: );
582: # Test to see if date windows are legitimate
583: if ($datequery=~/^Incorrect/) {
584: &output_date_error($r,$datequery);
585: return OK;
586: }
587: elsif ($datequery) {
588: push @queries,$datequery;
589: }
590:
591: # Process form information for custom metadata querying
592: my $customquery='';
593: if ($ENV{'form.custommetadata'}) {
594: $customquery=&build_custommetadata_query('custommetadata',
595: $ENV{'form.custommetadata'});
596: }
597: my $customshow='';
598: if ($ENV{'form.customshow'}) {
599: $customshow=$ENV{'form.customshow'};
600: $customshow=~s/[^\w\s]//g;
601: my @fields=split(/\s+/,$customshow);
602: $customshow=join(" ",@fields);
603: }
604: # Send query statements over the network to be processed by either the SQL
605: # database or a recursive scheme of 'grep'-like actions (for custom
606: # metadata).
607: if (@queries) {
608: $query=join(" AND ",@queries);
609: $query="select * from metadata where $query";
610: my $reply; # reply hash reference
611: unless ($customquery or $customshow) {
612: $reply=&Apache::lonnet::metadata_query($query);
613: }
614: else {
615: $reply=&Apache::lonnet::metadata_query($query,
616: $customquery,$customshow);
617: }
618: &output_results('Advanced',$r,$envhash,$customquery,$reply);
619: }
620: elsif ($customquery) {
621: my $reply; # reply hash reference
622: $reply=&Apache::lonnet::metadata_query('',
623: $customquery,$customshow);
624: &output_results('Advanced',$r,$envhash,$customquery,$reply);
625: }
626: # should not get to this point
627: return 'Error. Should not have gone to this point.';
628: }
629:
630: # ---------------------------------------------------- see if a field is filled
631: sub filled {
632: my ($field)=@_;
633: if ($field=~/\S/ && $field ne 'any') {
634: return 1;
635: }
636: else {
637: return 0;
638: }
639: }
640:
641: # --------------------------------------------------- Performing a basic search
642: sub basicsearch {
643: my ($r,$envhash)=@_;
644: my %ENV=%{$envhash};
645:
646: # Clean up fields for safety
647: for my $field ('basicexp') {
648: $ENV{"form.$field"}=~s/[^\w\s\(\)\-]//g;
649: }
650:
651: # Check to see if enough is filled in
652: unless (&filled($ENV{'form.basicexp'})) {
653: &output_blank_field_error($r);
654: return OK;
655: }
656:
657: # Build SQL query string based on form page
658: my $query='';
659: my $concatarg=join('," ",',
660: ('title', 'author', 'subject', 'notes', 'abstract'));
661: $query='select * from metadata where concat(' . $concatarg . ') like %' .
662: $ENV{'form.basicexp'} . '%';
663:
664: # Get reply (either a hash reference to filehandles or bad connection)
665: my $reply=&Apache::lonnet::metadata_query($query);
666:
667: # Output search results
668: &output_results('Basic',$r,$envhash,$query,$reply);
669:
670: return OK;
671: }
672:
673: # ---------------- Message to output when there are not enough fields filled in
674: sub output_blank_field_error {
675: my ($r)=@_;
676: # make query information persistent to allow for subsequent revision
677: my $persistent=&make_persistent();
678:
679: $r->print(<<BEGINNING);
680: <html>
681: <head>
682: <title>The LearningOnline Network with CAPA</title>
683: BEGINNING
684: $r->print(<<RESULTS);
685: </head>
686: <body bgcolor="#ffffff">
687: <img align=right src=/adm/lonIcons/lonlogos.gif>
688: <h1>Search Catalog</h1>
689: <form method="post" action="/adm/searchcat">
690: $persistent
691: <input type='button' value='Revise search request'
692: onClick='this.form.submit();'>
693: $closebutton
694: <hr>
695: <h3>Helpful Message</h3>
696: <p>
697: Incorrect search query due to blank entry fields.
698: You need to fill in the relevant
699: fields on the search page in order for a query to be
700: processed.
701: </p>
702: </body>
703: </html>
704: RESULTS
705: }
706:
707: # ----------------------------- format and output results based on a reply list
708: sub output_results {
709: my ($mode,$r,$envhash,$query,$replyref)=@_;
710: my %ENV=%{$envhash};
711: my %rhash=%{$replyref};
712: my $compiledresult='';
713: my $timeremain=30;
714: $r->print(<<BEGINNING);
715: <html>
716: <head>
717: <title>The LearningOnline Network with CAPA</title>
718: BEGINNING
719: $r->print(<<SCRIPT) if $ENV{'form.catalogmode'} eq 'interactive';
720: <script>
721: function select_data(title,url) {
722: changeTitle(title);
723: changeURL(url);
724: }
725: function changeTitle(val) {
726: if (opener.inf.document.forms.resinfo.elements.t) {
727: opener.inf.document.forms.resinfo.elements.t.value=val;
728: }
729: }
730: function changeURL(val) {
731: if (opener.inf.document.forms.resinfo.elements.u) {
732: opener.inf.document.forms.resinfo.elements.u.value=val;
733: }
734: }
735: </script>
736: SCRIPT
737: $r->print(<<CATALOGBEGIN);
738: </head>
739: <body bgcolor="#ffffff">
740: <img align=right src=/adm/lonIcons/lonlogos.gif>
741: <h1>Search Catalog</h1>
742: CATALOGBEGIN
743: $r->rflush();
744: $r->print(<<ENDPOP);
745: <script>
746: popwin=open('','popwin','width=400,height=200');
747: popwin.document.writeln('<html><body bgcolor="#FFFFFF">'+
748: '<h3>Search Results Progress</h3>'+
749: '<form name=popremain>'+
750: '<br />Server space <input type=text size=25 name=space value="">'+
751: '<br />Status <input type=text size=25 name=status value="">'+
752: '<br />Maximum remaining time <input type=text size=25 name=timeout value="30">'+
753: '</form>'+
754: '</body></html>');
755: popwin.document.close();
756: </script>
757: ENDPOP
758: $r->rflush();
759:
760: my $servernum=(keys %rhash)+0;
761: $r->print('<script>popwin.document.popremain.space.value="'.
762: $servernum.', 0%, count=0/1";</script>');
763: $r->rflush();
764: foreach my $rkey (keys %rhash) {
765: $r->print('<script>popwin.document.popremain.status.value="'.
766: $rkey.', trying contact";</script>');
767: $r->rflush();
768: my $reply=$rhash{$rkey};
769: my @results;
770:
771: my $replyfile='';
772: $reply=~/^([\.\w]+)$/; # must do since 'use strict' checks for tainting
773: $replyfile=$r->dir_config('lonDaemons').'/tmp/'.$1;
774: $reply=~/(.*?)\_/;
775: my $hostname=$1;
776: {
777: while (1) {
778: $r->print('<script>popwin.document.popremain.status.value="'.
779: $rkey.', contacted";</script>') if -e $replyfile;
780: $r->rflush();
781: last if -e "$replyfile.end";
782: last unless $timeremain;
783: sleep 1;
784: $timeremain--;
785: $r->print('<script>popwin.document.popremain.timeout.value="'.
786: $timeremain.'";</script>');
787: $r->rflush();
788: }
789: # QUESTION: how should I handle this error condition..
790: # I'm sure there is syntax elsewhere I can use..
791: my $fh=Apache::File->new($replyfile) or
792: ($r->print('file cannot be opened') and return OK);
793: @results=<$fh>;
794: }
795:
796: my $customshow='';
797: my $extrashow='';
798: my @customfields;
799: if ($ENV{'form.customshow'}) {
800: $customshow=$ENV{'form.customshow'};
801: $customshow=~s/[^\w\s]//g;
802: my @fields=map {"<font color=\"#008000\">$_:</font><!-- $_ -->"}
803: split(/\s+/,$customshow);
804: @customfields=split(/\s+/,$customshow);
805: if ($customshow) {
806: $extrashow="<ul><li>".join("</li><li>",@fields)."</li></ul>\n";
807: }
808: }
809: my $customdata='';
810: my %customhash;
811: foreach my $result (@results) {
812: if ($result=~/^(custom\=.*)$/) { # grab all custom metadata
813: my $tmp=$result;
814: $tmp=~s/^custom\=//;
815: my ($k,$v)=map {&Apache::lonnet::unescape($_);
816: } split(/\,/,$tmp);
817: $customhash{$k}=$v;
818: }
819: }
820: foreach my $result (@results) {
821: next if $result=~/^custom\=/;
822: chomp $result;
823: next unless $result;
824: my @fields=map
825: {&Apache::lonnet::unescape($_)}
826: (split(/\,/,$result));
827: my ($title,$author,$subject,$url,$keywords,$version,
828: $notes,$abstract,$mime,$lang,
829: $creationdate,$lastrevisiondate,$owner,$copyright)=@fields;
830: my $shortabstract=$abstract;
831: $shortabstract=substr($abstract,0,200) if length($abstract)>200;
832: $fields[7]=$shortabstract;
833: my $extrashow2=$extrashow;
834: if ($extrashow) {
835: foreach my $field (@customfields) {
836: my $value='';
837: if ($customhash{$url}=~/\<${field}[^\>]*\>(.*?)\<\/${field}[^\>]*\>/s) {
838: $value=$1;
839: }
840: $extrashow2=~s/\<\!\-\- $field \-\-\>/ $value/g;
841: }
842: }
843:
844: $compiledresult.=<<END if $compiledresult;
845: <hr align='left' width='200' noshade />
846: END
847: $compiledresult.=<<END;
848: <p>
849: END
850: $compiledresult.=<<END if $ENV{'form.catalogmode'} eq 'interactive';
851: <font size='-1'><INPUT TYPE="button" NAME="returnvalues" VALUE="SELECT"
852: onClick="javascript:select_data('$title','$url')">
853: </font>
854: <br>
855: END
856: my $httphost=$ENV{'HTTP_HOST'};
857:
858: my $viewselect;
859: if ($mode eq 'Basic') {
860: $viewselect=$ENV{'form.basicviewselect'};
861: }
862: elsif ($mode eq 'Advanced') {
863: $viewselect=$ENV{'form.advancedviewselect'};
864: }
865:
866: if ($viewselect eq 'Detailed Citation View') {
867: $compiledresult.=&detailed_citation_view(@fields,
868: $hostname,$httphost,
869: $extrashow2);
870: }
871: elsif ($viewselect eq 'Summary View') {
872: $compiledresult.=&summary_view(@fields,$hostname,$httphost,
873: $extrashow2);
874: }
875: elsif ($viewselect eq 'Fielded Format') {
876: $compiledresult.=&fielded_format_view(@fields,$hostname,
877: $httphost,$extrashow2);
878: }
879: elsif ($viewselect eq 'XML/SGML') {
880: $compiledresult.=&xml_sgml_view(@fields,$hostname,$httphost,
881: $extrashow2);
882: }
883:
884: }
885:
886: unless ($compiledresult) {
887: $compiledresult="There were no results that matched your query";
888: }
889:
890: # make query information persistent to allow for subsequent revision
891: my $persistent=&make_persistent();
892:
893: $r->print(<<RESULTS);
894: <form method="post" action="/adm/searchcat">
895: $customdata
896: <input type='button' value='Revise search request'
897: onClick='this.form.submit();'>
898: $closebutton
899: $persistent
900: <hr>
901: <h3>Search Query</h3>
902: RESULTS
903: if ($mode eq 'Basic') {
904: $r->print(<<RESULTS);
905: <p>
906: <b>Basic search:</b> $ENV{'form.basicexp'}
907: </p>
908: RESULTS
909: }
910: elsif ($mode eq 'Advanced') {
911: $r->print(<<RESULTS);
912: <p>
913: <b>Advanced search</b>
914: $query
915: </p>
916: RESULTS
917: }
918: $r->print(<<RESULTS);
919: <h3>Search Results</h3>
920: $compiledresult
921: </body>
922: </html>
923: RESULTS
924: }
925: $r->print('<script>popwin.close()</script>'); $r->rflush();
926: }
927:
928: # ------------------------------------------------------------- build_SQL_query
929: sub build_SQL_query {
930: my ($field_name,$logic_statement)=@_;
931: my $q=new Text::Query('abc',
932: -parse => 'Text::Query::ParseAdvanced',
933: -build => 'Text::Query::Build');
934: $q->prepare($logic_statement);
935: my $matchexp=${$q}{'matchexp'}; chomp $matchexp;
936: my $sql_query=&recursive_SQL_query_build($field_name,$matchexp);
937: return $sql_query;
938: }
939:
940: # ------------------------------------------------- build custom metadata query
941: sub build_custommetadata_query {
942: my ($field_name,$logic_statement)=@_;
943: my $q=new Text::Query('abc',
944: -parse => 'Text::Query::ParseAdvanced',
945: -build => 'Text::Query::BuildAdvancedString');
946: $q->prepare($logic_statement);
947: my $matchexp=${$q}{'-parse'}{'-build'}{'matchstring'};
948: # quick fix to change literal into xml tag-matching
949: # will eventually have to write a separate builder module
950: my $oldmatchexp=$matchexp;
951: $matchexp=~s/(\w+)\\\=([\w\\\+]+)/\\\<$1\\\>\[\^\\\<\]\*$2\[\^\\\<\]\*\\\<\\\/$1\\\>/g;
952: return $matchexp;
953: }
954:
955: # - Recursively parse a reverse notation expression into a SQL query expression
956: sub recursive_SQL_query_build {
957: my ($dkey,$pattern)=@_;
958: my @matches=($pattern=~/(\[[^\]|\[]*\])/g);
959: return $pattern unless @matches;
960: foreach my $match (@matches) {
961: $match=~/\[ (\w+)\s(.*) \]/;
962: my ($key,$value)=($1,$2);
963: my $replacement='';
964: if ($key eq 'literal') {
965: $replacement="($dkey like \"\%$value\%\")";
966: }
967: elsif ($key eq 'and') {
968: $value=~/(.*[\"|\)]) ([|\(|\^].*)/;
969: $replacement="($1 AND $2)";
970: }
971: elsif ($key eq 'or') {
972: $value=~/(.*[\"|\)]) ([|\(|\^].*)/;
973: $replacement="($1 OR $2)";
974: }
975: substr($pattern,
976: index($pattern,$match),
977: length($match),
978: $replacement
979: );
980: }
981: &recursive_SQL_query_build($dkey,$pattern);
982: }
983:
984: # ------------------------------------------------------ Detailed Citation View
985: sub detailed_citation_view {
986: my ($title,$author,$subject,$url,$keywords,$version,
987: $notes,$shortabstract,$mime,$lang,
988: $creationdate,$lastrevisiondate,$owner,$copyright,
989: $hostname,$httphost,$extrashow)=@_;
990: my $result=<<END;
991: <i>$owner</i>, last revised $lastrevisiondate
992: <h3><A HREF="http://$httphost$url" TARGET='search_preview'>$title</A></h3>
993: <h3>$author</h3>
994: </p>
995: <p>
996: <b>Subject:</b> $subject<br>
997: <b>Keyword(s):</b> $keywords<br>
998: <b>Notes:</b> $notes<br>
999: <b>MIME Type:</b> $mimetag{$mime}<br>
1000: <b>Language:</b> $language{$lang}<br>
1001: <b>Copyright/Distribution:</b> $cprtag{$copyright}<br>
1002: </p>
1003: $extrashow
1004: <p>
1005: $shortabstract
1006: </p>
1007: END
1008: return $result;
1009: }
1010:
1011: # ---------------------------------------------------------------- Summary View
1012: sub summary_view {
1013: my ($title,$author,$subject,$url,$keywords,$version,
1014: $notes,$shortabstract,$mime,$lang,
1015: $creationdate,$lastrevisiondate,$owner,$copyright,
1016: $hostname,$httphost,$extrashow)=@_;
1017: my $result=<<END;
1018: <a href="http://$httphost$url" TARGET='search_preview'>$author</a><br />
1019: $title<br />
1020: $owner -- $lastrevisiondate<br />
1021: $cprtag{$copyright}<br />
1022: $extrashow
1023: </p>
1024: END
1025: return $result;
1026: }
1027:
1028: # -------------------------------------------------------------- Fielded Format
1029: sub fielded_format_view {
1030: my ($title,$author,$subject,$url,$keywords,$version,
1031: $notes,$shortabstract,$mime,$lang,
1032: $creationdate,$lastrevisiondate,$owner,$copyright,
1033: $hostname,$httphost,$extrashow)=@_;
1034: my $result=<<END;
1035: <b>URL: </b> <A HREF="http://$httphost$url" TARGET='search_preview'>$url</A>
1036: <br />
1037: <b>Title:</b> $title<br />
1038: <b>Author(s):</b> $author<br />
1039: <b>Subject:</b> $subject<br />
1040: <b>Keyword(s):</b> $keywords<br />
1041: <b>Notes:</b> $notes<br />
1042: <b>MIME Type:</b> $mimetag{$mime}<br />
1043: <b>Language:</b> $language{$lang}<br />
1044: <b>Creation Date:</b> $creationdate<br />
1045: <b>Last Revision Date:</b> $lastrevisiondate<br />
1046: <b>Publisher/Owner:</b> $owner<br />
1047: <b>Copyright/Distribution:</b> $cprtag{$copyright}<br />
1048: <b>Repository Location:</b> $hostname<br />
1049: <b>Abstract:</b> $shortabstract<br />
1050: $extrashow
1051: </p>
1052: END
1053: return $result;
1054: }
1055:
1056: # -------------------------------------------------------------------- XML/SGML
1057: sub xml_sgml_view {
1058: my ($title,$author,$subject,$url,$keywords,$version,
1059: $notes,$shortabstract,$mime,$lang,
1060: $creationdate,$lastrevisiondate,$owner,$copyright,
1061: $hostname,$httphost,$extrashow)=@_;
1062: my $result=<<END;
1063: <pre>
1064: <LonCapaResource>
1065: <url>$url</url>
1066: <title>$title</title>
1067: <author>$author</author>
1068: <subject>$subject</subject>
1069: <keywords>$keywords</keywords>
1070: <notes>$notes</notes>
1071: <mimeInfo>
1072: <mime>$mime</mime>
1073: <mimetag>$mimetag{$mime}</mimetag>
1074: </mimeInfo>
1075: <languageInfo>
1076: <language>$lang</language>
1077: <languagetag>$language{$lang}</languagetag>
1078: </languageInfo>
1079: <creationdate>$creationdate</creationdate>
1080: <lastrevisiondate>$lastrevisiondate</lastrevisiondate>
1081: <owner>$owner</owner>
1082: <copyrightInfo>
1083: <copyright>$copyright</copyright>
1084: <copyrighttag>$cprtag{$copyright}</copyrighttag>
1085: </copyrightInfo>
1086: <repositoryLocation>$hostname</repositoryLocation>
1087: <shortabstract>$shortabstract</shortabstract>
1088: </LonCapaResource>
1089: </pre>
1090: $extrashow
1091: END
1092: return $result;
1093: }
1094:
1095: sub build_date_queries {
1096: my ($cmonth1,$cday1,$cyear1,$cmonth2,$cday2,$cyear2,
1097: $lmonth1,$lday1,$lyear1,$lmonth2,$lday2,$lyear2)=@_;
1098: my @queries;
1099: if ($cmonth1 or $cday1 or $cyear1 or $cmonth2 or $cday2 or $cyear2) {
1100: unless ($cmonth1 and $cday1 and $cyear1 and
1101: $cmonth2 and $cday2 and $cyear2) {
1102: return "Incorrect entry for the creation date. You must specify ".
1103: "a starting month, day, and year and an ending month, ".
1104: "day, and year.";
1105: }
1106: my $cnumeric1=sprintf("%d%2d%2d",$cyear1,$cmonth1,$cday1);
1107: $cnumeric1+=0;
1108: my $cnumeric2=sprintf("%d%2d%2d",$cyear2,$cmonth2,$cday2);
1109: $cnumeric2+=0;
1110: if ($cnumeric1>$cnumeric2) {
1111: return "Incorrect entry for the creation date. The starting ".
1112: "date must occur before the ending date.";
1113: }
1114: my $cquery="(creationdate BETWEEN '$cyear1-$cmonth1-$cday1' AND '".
1115: "$cyear2-$cmonth2-$cday2 23:59:59')";
1116: push @queries,$cquery;
1117: }
1118: if ($lmonth1 or $lday1 or $lyear1 or $lmonth2 or $lday2 or $lyear2) {
1119: unless ($lmonth1 and $lday1 and $lyear1 and
1120: $lmonth2 and $lday2 and $lyear2) {
1121: return "Incorrect entry for the last revision date. You must ".
1122: "specify a starting month, day, and year and an ending ".
1123: "month, day, and year.";
1124: }
1125: my $lnumeric1=sprintf("%d%2d%2d",$lyear1,$lmonth1,$lday1);
1126: $lnumeric1+=0;
1127: my $lnumeric2=sprintf("%d%2d%2d",$lyear2,$lmonth2,$lday2);
1128: $lnumeric2+=0;
1129: if ($lnumeric1>$lnumeric2) {
1130: return "Incorrect entry for the last revision date. The ".
1131: "starting date must occur before the ending date.";
1132: }
1133: my $lquery="(lastrevisiondate BETWEEN '$lyear1-$lmonth1-$lday1' AND '".
1134: "$lyear2-$lmonth2-$lday2 23:59:59')";
1135: push @queries,$lquery;
1136: }
1137: if (@queries) {
1138: return join(" AND ",@queries);
1139: }
1140: return '';
1141: }
1142:
1143: sub output_date_error {
1144: my ($r,$message)=@_;
1145: # make query information persistent to allow for subsequent revision
1146: my $persistent=&make_persistent();
1147:
1148: $r->print(<<BEGINNING);
1149: <html>
1150: <head>
1151: <title>The LearningOnline Network with CAPA</title>
1152: BEGINNING
1153: $r->print(<<RESULTS);
1154: </head>
1155: <body bgcolor="#ffffff">
1156: <img align=right src=/adm/lonIcons/lonlogos.gif>
1157: <h1>Search Catalog</h1>
1158: <form method="post" action="/adm/searchcat">
1159: $persistent
1160: <input type='button' value='Revise search request'
1161: onClick='this.form.submit();'>
1162: $closebutton
1163: <hr>
1164: <h3>Helpful Message</h3>
1165: <p>
1166: $message
1167: </p>
1168: </body>
1169: </html>
1170: RESULTS
1171: }
1172:
1173: sub make_persistent {
1174: my $persistent='';
1175:
1176: map {
1177: if (/^form\./ && !/submit/) {
1178: my $name=$_;
1179: my $key=$name;
1180: $ENV{$key}=~s/\'//g; # do not mess with html field syntax
1181: $name=~s/^form\.//;
1182: $persistent.=<<END;
1183: <input type='hidden' name='$name' value='$ENV{$key}' />
1184: END
1185: }
1186: } (keys %ENV);
1187: return $persistent;
1188: }
1189: 1;
1190: __END__
FreeBSD-CVSweb <freebsd-cvsweb@FreeBSD.org>