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