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