Annotation of loncom/interface/lonsearchcat.pm, revision 1.310
1.98 harris41 1: # The LearningOnline Network with CAPA
1.108 harris41 2: # Search Catalog
3: #
1.310 ! bisitz 4: # $Id: lonsearchcat.pm,v 1.309 2009/07/02 17:05:31 bisitz 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().
1.309 bisitz 194: '&catalogmode='.$env{'form.catalogmode'}.
195: '&launch='.$env{'form.launch'}.
196: '&mode='.$env{'form.mode'},
1.277 raeburn 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.291 bisitz 269: $closebutton="<input type='button' name='close' value='".&mt('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.291 bisitz 277: $closebutton="<input type='button' name='close' value='".&mt('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.297 bisitz 284: my $txt_import = &mt('IMPORT');
1.98 harris41 285: $importbutton=<<END;
1.297 bisitz 286: <input type='button' name='import' value='$txt_import'
1.98 harris41 287: onClick='javascript:select_group()'>
288: END
1.146 matthew 289: } else {
290: $closebutton = '';
291: $importbutton = '';
1.98 harris41 292: }
1.124 matthew 293: ##
1.146 matthew 294: ## Sanity checks on form elements
1.124 matthew 295: ##
1.243 albertel 296: if (!defined($env{'form.viewselect'})) {
1.248 www 297: $env{'form.viewselect'} ="summary";
1.146 matthew 298: }
1.243 albertel 299: $env{'form.phase'} = 'disp_basic' if (! exists($env{'form.phase'}));
300: $env{'form.show'} = 20 if (! exists($env{'form.show'}));
1.209 matthew 301: #
1.243 albertel 302: $env{'form.searchmode'} = 'basic' if (! exists($env{'form.searchmode'}));
303: if ($env{'form.phase'} eq 'adv_search' ||
304: $env{'form.phase'} eq 'disp_adv') {
305: $env{'form.searchmode'} = 'advanced';
306: } elsif ($env{'form.phase'} eq 'course_search') {
307: $env{'form.searchmode'} = 'course_search';
1.209 matthew 308: }
309: #
1.243 albertel 310: if ($env{'form.searchmode'} eq 'advanced') {
1.277 raeburn 311: my $srchtype = 'Catalog';
312: if ($env{'form.area'} eq 'portfolio') {
313: $srchtype = 'Portfolio';
314: }
1.209 matthew 315: &Apache::lonhtmlcommon::add_breadcrumb
1.288 albertel 316: ({href=>'/adm/searchcat?'.&Apache::loncommon::inhibit_menu_check().
1.309 bisitz 317: '&phase=disp_adv'.
318: '&catalogmode='.$env{'form.catalogmode'}.
319: '&launch='.$env{'form.launch'}.
320: '&mode='.$env{'form.mode'},
1.277 raeburn 321: text=>"Advanced $srchtype Search",
1.209 matthew 322: bug=>'Searching',});
1.243 albertel 323: } elsif ($env{'form.searchmode'} eq 'course search') {
1.209 matthew 324: &Apache::lonhtmlcommon::add_breadcrumb
1.288 albertel 325: ({href=>'/adm/searchcat?'.&Apache::loncommon::inhibit_menu_check().
1.309 bisitz 326: '&phase=disp_adv'.
1.243 albertel 327: 'catalogmode='.$env{'form.catalogmode'}.
1.309 bisitz 328: '&launch='.$env{'form.launch'}.
329: '&mode='.$env{'form.mode'},
1.209 matthew 330: text=>"Course Search",
331: bug=>'Searching',});
332: }
1.146 matthew 333: ##
334: ## Switch on the phase
335: ##
1.243 albertel 336: if ($env{'form.phase'} eq 'disp_basic') {
1.196 matthew 337: &print_basic_search_form($r,$closebutton,$hidden_fields);
1.243 albertel 338: } elsif ($env{'form.phase'} eq 'disp_adv') {
1.196 matthew 339: &print_advanced_search_form($r,$closebutton,$hidden_fields);
1.243 albertel 340: } elsif ($env{'form.phase'} eq 'results') {
1.276 raeburn 341: &display_results($r,$importbutton,$closebutton,$diropendb,
342: $env{'form.area'});
1.243 albertel 343: } elsif ($env{'form.phase'} =~ /^(sort|run_search)$/) {
1.146 matthew 344: my ($query,$customquery,$customshow,$libraries,$pretty_string) =
345: &get_persistent_data($persistent_db_file,
346: ['query','customquery','customshow',
347: 'libraries','pretty_string']);
1.243 albertel 348: if ($env{'form.phase'} eq 'sort') {
1.151 matthew 349: &print_sort_form($r,$pretty_string);
1.243 albertel 350: } elsif ($env{'form.phase'} eq 'run_search') {
1.151 matthew 351: &run_search($r,$query,$customquery,$customshow,
1.276 raeburn 352: $libraries,$pretty_string,$env{'form.area'});
1.151 matthew 353: }
1.243 albertel 354: } elsif ($env{'form.phase'} eq 'course_search') {
1.167 www 355: &course_search($r);
1.243 albertel 356: } elsif(($env{'form.phase'} eq 'basic_search') ||
357: ($env{'form.phase'} eq 'adv_search')) {
1.228 matthew 358: #
359: # We are running a search, try to parse it
360: my ($query,$customquery,$customshow,$libraries) =
361: (undef,undef,undef,undef);
362: my $pretty_string;
1.243 albertel 363: if ($env{'form.phase'} eq 'basic_search') {
1.228 matthew 364: ($query,$pretty_string,$libraries) =
365: &parse_basic_search($r,$closebutton,$hidden_fields);
366: return OK if (! defined($query));
1.243 albertel 367: &make_persistent({ basicexp => $env{'form.basicexp'}},
1.228 matthew 368: $persistent_db_file);
369: } else { # Advanced search
370: ($query,$customquery,$customshow,$libraries,$pretty_string)
371: = &parse_advanced_search($r,$closebutton,$hidden_fields);
372: return OK if (! defined($query));
373: }
374: &make_persistent({ query => $query,
375: customquery => $customquery,
376: customshow => $customshow,
377: libraries => $libraries,
378: pretty_string => $pretty_string },
379: $persistent_db_file);
380: #
1.146 matthew 381: # Set up table
1.276 raeburn 382: if (! defined(&create_results_table($env{'form.area'}))) {
1.198 www 383: my $errorstring=&Apache::lonmysql::get_error();
1.211 matthew 384: &Apache::lonnet::logthis('lonsearchcat.pm: Unable to create '.
385: 'needed table. lonmysql error:'.
386: $errorstring);
1.256 albertel 387:
388: my $msg =
1.286 albertel 389: 'Unable to create table in which to save search results. '.
1.256 albertel 390: 'The search has been aborted.';
1.261 albertel 391: &Apache::loncommon::simple_error_page($r,'Search Error',
392: $msg);
393: return OK;
1.146 matthew 394: }
1.243 albertel 395: delete($env{'form.launch'});
1.146 matthew 396: if (! &make_form_data_persistent($r,$persistent_db_file)) {
1.256 albertel 397: my $msg=
1.286 albertel 398: 'Unable to properly save search information. '.
1.256 albertel 399: 'The search has been aborted.';
1.261 albertel 400: &Apache::loncommon::simple_error_page($r,'Search Error',
401: $msg);
402: return OK;
1.256 albertel 403: }
1.145 matthew 404: ##
1.146 matthew 405: ## Print out the frames interface
1.145 matthew 406: ##
1.228 matthew 407: if (defined($query)) {
408: &print_frames_interface($r);
409: }
1.124 matthew 410: }
411: return OK;
412: }
1.98 harris41 413:
1.221 matthew 414: #
415: # The mechanism used to store values away and retrieve them does not
416: # handle the case of missing environment variables being significant.
417: #
418: # This routine sets non existant checkbox form elements to ''.
419: #
420: sub clean_up_environment {
1.243 albertel 421: if ($env{'form.phase'} eq 'basic_search') {
422: if (! exists($env{'form.related'})) {
423: $env{'form.related'} = '';
1.221 matthew 424: }
1.243 albertel 425: if (! exists($env{'form.domains'})) {
426: $env{'form.domains'} = '';
1.221 matthew 427: }
1.243 albertel 428: } elsif ($env{'form.phase'} eq 'adv_search') {
1.221 matthew 429: foreach my $field ('title','keywords','notes',
430: 'abstract','standards','mime') {
1.243 albertel 431: if (! exists($env{'form.'.$field.'_related'})) {
432: $env{'form.'.$field.'_related'} = '';
1.221 matthew 433: }
434: }
1.243 albertel 435: } elsif ($env{'form.phase'} eq 'course_search') {
436: if (! exists($env{'form.crsrelated'})) {
437: $env{'form.crsrelated'} = '';
1.221 matthew 438: }
439: }
440: }
441:
1.223 matthew 442: sub hidden_field {
443: my ($name,$value) = @_;
444: if (! defined($value)) {
1.243 albertel 445: $value = $env{'form.'.$name};
1.223 matthew 446: }
447: return '<input type="hidden" name="'.$name.'" value="'.$value.'" />'.$/;
448: }
449:
1.124 matthew 450: ######################################################################
451: ######################################################################
1.196 matthew 452: ##
453: ## Course Search
454: ##
455: ######################################################################
456: ######################################################################
457: { # Scope the course search to avoid global variables
458: #
459: # Variables For course search
1.236 albertel 460: my %alreadyseen;
1.196 matthew 461: my %hash;
462: my $totalfound;
1.124 matthew 463:
1.235 albertel 464: sub make_symb {
465: my ($id)=@_;
466: my ($mapid,$resid)=split(/\./,$id);
467: my $map=$hash{'map_id_'.$mapid};
468: my $res=$hash{'src_'.$id};
469: my $symb=&Apache::lonnet::encode_symb($map,$resid,$res);
470: return $symb;
471: }
472:
1.167 www 473: sub course_search {
474: my $r=shift;
1.243 albertel 475: my $pretty_search_string = '<b>'.$env{'form.courseexp'}.'</b>';
476: my $search_string = $env{'form.courseexp'};
1.167 www 477: my @New_Words;
1.236 albertel 478: undef(%alreadyseen);
1.243 albertel 479: if ($env{'form.crsrelated'}) {
480: ($search_string,@New_Words) = &related_version($env{'form.courseexp'});
1.167 www 481: if (@New_Words) {
1.200 www 482: $pretty_search_string .= ' '.&mt("with related words").": <b>@New_Words</b>.";
1.167 www 483: } else {
1.200 www 484: $pretty_search_string .= ' '.&mt('with no related words').".";
1.167 www 485: }
486: }
1.243 albertel 487: my $fulltext=$env{'form.crsfulltext'};
488: my $discuss=$env{'form.crsdiscuss'};
1.167 www 489: my @allwords=($search_string,@New_Words);
1.169 www 490: $totalfound=0;
1.256 albertel 491: $r->print(&Apache::loncommon::start_page('Course Search').
492: '<hr /><center><font size="+2" face="arial">'.
493: $pretty_search_string.'</font></center>'.
494: '<hr /><b>'.&mt('Course content').':</b><br />');
1.167 www 495: $r->rflush();
496: # ======================================================= Go through the course
1.169 www 497: my $c=$r->connection;
1.243 albertel 498: if (tie(%hash,'GDBM_File',$env{'request.course.fn'}.".db",
1.196 matthew 499: &GDBM_READER(),0640)) {
1.235 albertel 500: foreach (sort(keys(%hash))) {
1.196 matthew 501: if ($c->aborted()) { last; }
1.235 albertel 502: if (($_=~/^src\_(.+)$/)) {
1.243 albertel 503: if ($hash{'randomout_'.$1} & !$env{'request.role.adv'}) {
1.235 albertel 504: next;
505: }
506: my $symb=&make_symb($1);
507: &checkonthis($r,$1,$hash{$_},0,&Apache::lonnet::gettitle($symb),
508: $fulltext,$symb,@allwords);
1.196 matthew 509: }
510: }
511: untie(%hash);
512: }
1.169 www 513: unless ($totalfound) {
1.231 raeburn 514: $r->print('<p>'.&mt('No matches found in resources').'.</p>');
1.169 www 515: }
1.231 raeburn 516:
517: # Check discussions if requested
518: if ($discuss) {
519: my $totaldiscussions = 0;
520: $r->print('<br /><br /><b>'.&mt('Discussion postings').':</b><br />');
521: my $navmap = Apache::lonnavmaps::navmap->new();
1.303 raeburn 522: if (defined($navmap)) {
523: my @allres=$navmap->retrieveResources();
524: my %discussiontime = &Apache::lonnet::dump('discussiontimes',
525: $env{'course.'.$env{'request.course.id'}.'.domain'},
526: $env{'course.'.$env{'request.course.id'}.'.num'});
527: foreach my $resource (@allres) {
528: my $result = '';
529: my $applies = 0;
530: my $symb = $resource->symb();
531: my $ressymb = $symb;
532: if ($symb =~ m#(___adm/$LONCAPA::domain_re/$LONCAPA::username_re)/(\d+)/bulletinboard$#) {
533: $ressymb = 'bulletin___'.$2.$1.'/'.$2.'/bulletinboard';
534: unless ($ressymb =~ m#bulletin___\d+___adm/wrapper#) {
535: $ressymb=~s#(bulletin___\d+___)#$1adm/wrapper/#;
536: }
1.231 raeburn 537: }
1.303 raeburn 538: if (defined($discussiontime{$ressymb})) {
539: my %contrib = &Apache::lonnet::restore($ressymb,$env{'request.course.id'},
540: $env{'course.'.$env{'request.course.id'}.'.domain'},
541: $env{'course.'.$env{'request.course.id'}.'.num'});
542: if ($contrib{'version'}) {
543: for (my $id=1;$id<=$contrib{'version'};$id++) {
544: unless (($contrib{'hidden'}=~/\.$id\./) || ($contrib{'deleted'}=~/\.$id\./)) {
545: if ($contrib{$id.':subject'}) {
546: $result .= $contrib{$id.':subject'};
547: }
548: if ($contrib{$id.':message'}) {
549: $result .= $contrib{$id.':message'};
550: }
551: if ($contrib{$id,':attachmenturl'}) {
552: if ($contrib{$id,':attachmenturl'} =~ m-/([^/]+)$-) {
553: $result .= $1;
554: }
1.231 raeburn 555: }
1.303 raeburn 556: $applies = &checkwords($result,$applies,@allwords);
1.231 raeburn 557: }
558: }
559: }
560: }
561: # Does this discussion apply?
1.303 raeburn 562: if ($applies) {
563: my ($map,$ind,$url)=&Apache::lonnet::decode_symb($ressymb);
564: my $disctype = &mt('resource');
565: if ($url =~ m#/bulletinboard$#) {
566: if ($url =~m#^adm/wrapper/adm/.*/bulletinboard$#) {
567: $url =~s#^adm/wrapper##;
568: }
1.304 schafran 569: $disctype = &mt('discussion board');
1.303 raeburn 570: } else {
571: $url = '/res/'.$url;
1.231 raeburn 572: }
1.303 raeburn 573: if ($url =~ /\?/) {
1.309 bisitz 574: $url .= '&symb=';
1.303 raeburn 575: } else {
576: $url .= '?symb=';
577: }
578: $url .= &escape($resource->symb());
579: my $title = $resource->compTitle();
580: $r->print('<br /><a href="'.$url.'" target="cat">'.
581: ($title?$title:$url).'</a> - '.
582: $disctype.'<br />');
583: $totaldiscussions++;
1.231 raeburn 584: } else {
1.303 raeburn 585: $r->print(' .');
1.231 raeburn 586: }
587: }
1.303 raeburn 588: unless ($totaldiscussions) {
589: $r->print('<p>'.&mt('No matches found in postings').'.</p>');
590: }
591: } else {
592: $r->print('<div class="LC_error">'.&mt('An error occurred retrieving information about resources in the course.').'<br />'.&mt('It is recommended that you [_1]re-initialize the course[_2] and then try your search again.','<a href="/adm/roles">','</a>').'</div>');
1.231 raeburn 593: }
594: }
595:
1.167 www 596: # =================================================== Done going through course
1.256 albertel 597: $r->print(&Apache::loncommon::end_page());
1.167 www 598: }
599:
600: # =============================== This pulls up a resource and its dependencies
601:
602: sub checkonthis {
1.235 albertel 603: my ($r,$id,$url,$level,$title,$fulltext,$symb,@allwords)=@_;
1.236 albertel 604: $alreadyseen{$id}=1;
605: if (&Apache::loncommon::connection_aborted($r)) { return; }
1.167 www 606: $r->rflush();
1.235 albertel 607:
608: my $result=$title.' ';
1.243 albertel 609: if ($env{'request.role.adv'} || !$hash{'encrypted_'.$id}) {
1.235 albertel 610: $result.=&Apache::lonnet::metadata($url,'title').' '.
611: &Apache::lonnet::metadata($url,'subject').' '.
612: &Apache::lonnet::metadata($url,'abstract').' '.
613: &Apache::lonnet::metadata($url,'keywords');
614: }
615: my ($extension)=($url=~/\.(\w+)$/);
616: if (&Apache::loncommon::fileembstyle($extension) eq 'ssi' &&
617: ($url) && ($fulltext)) {
1.265 www 618: $result.=&Apache::lonnet::ssi_body($url.'?symb='.&escape($symb));
1.167 www 619: }
620: $result=~s/\s+/ /gs;
1.231 raeburn 621: my $applies = 0;
622: $applies = &checkwords($result,$applies,@allwords);
1.167 www 623: # Does this resource apply?
624: if ($applies) {
625: $r->print('<br />');
626: for (my $i=0;$i<=$level*5;$i++) {
627: $r->print(' ');
628: }
1.235 albertel 629: my $href=$url;
1.243 albertel 630: if ($hash{'encrypted_'.$id} && !$env{'request.role.adv'}) {
1.235 albertel 631: $href=&Apache::lonenc::encrypted($href)
632: .'?symb='.&Apache::lonenc::encrypted($symb);
633: } else {
1.265 www 634: $href.='?symb='.&escape($symb);
1.235 albertel 635: }
636: $r->print('<a href="'.$href.'" target="cat">'.($title?$title:$url).
637: '</a><br />');
1.169 www 638: $totalfound++;
639: } elsif ($fulltext) {
640: $r->print(' .');
1.167 www 641: }
1.169 www 642: $r->rflush();
1.167 www 643: # Check also the dependencies of this one
644: my $dependencies=
645: &Apache::lonnet::metadata($url,'dependencies');
1.237 albertel 646: foreach (split(/\,/,$dependencies)) {
647: if (($_=~/^\/res\//) && (!$alreadyseen{$id})) {
1.235 albertel 648: &checkonthis($r,$id,$_,$level+1,'',$fulltext,undef,@allwords);
1.167 www 649: }
650: }
651: }
652:
1.231 raeburn 653: sub checkwords {
654: my ($result,$applies,@allwords) = @_;
655: foreach (@allwords) {
656: if ($_=~/\w/) {
657: if ($result=~/$_/si) {
658: $applies++;
659: }
660: }
661: }
662: return $applies;
663: }
664:
1.196 matthew 665: sub untiehash {
666: if (tied(%hash)) {
667: untie(%hash);
668: }
669: }
670:
671: } # End of course search scoping
672:
1.207 matthew 673:
1.167 www 674: ######################################################################
675: ######################################################################
676:
1.124 matthew 677: =pod
678:
1.146 matthew 679: =item &print_basic_search_form()
1.124 matthew 680:
1.204 matthew 681: Prints the form for the basic search. Sorry the name is so cryptic.
1.124 matthew 682:
683: =cut
684:
685: ######################################################################
686: ######################################################################
1.204 matthew 687: sub print_basic_search_form {
1.196 matthew 688: my ($r,$closebutton,$hidden_fields) = @_;
1.267 www 689: my $result = ($env{'form.catalogmode'} ne 'import');
1.256 albertel 690: my $bread_crumb =
1.263 albertel 691: &Apache::lonhtmlcommon::breadcrumbs('Searching','Search_Basic',
1.267 www 692: $env{'form.catalogmode'} ne 'import');
1.305 schafran 693: my $scrout = &Apache::loncommon::start_page('Content Library').$bread_crumb;
1.276 raeburn 694: # Search form for resource space
1.243 albertel 695: if (&Apache::lonnet::allowed('bre',$env{'request.role.domain'})) {
1.276 raeburn 696: $scrout .= &setup_basic_search($r,'res',$hidden_fields,$closebutton);
697: $scrout .= '<hr /><br />';
1.180 matthew 698: }
1.276 raeburn 699: # Search form for accessible portfolio files
700: $scrout.= &setup_basic_search($r,'portfolio',$hidden_fields,$closebutton);
1.243 albertel 701: if ($env{'request.course.id'}) {
1.213 matthew 702: my %lt=&Apache::lonlocal::texthash('srch' => 'Search',
1.187 www 703: 'header' => 'Course Search',
704: 'note' => 'Enter terms or phrases, then press "Search" below',
1.200 www 705: 'use' => 'use related words',
1.231 raeburn 706: 'full' =>'fulltext search (time consuming)',
1.304 schafran 707: 'disc' => 'search discussion postings (resources and discussion boards)',
1.187 www 708: );
1.180 matthew 709: $scrout.=(<<ENDCOURSESEARCH);
1.213 matthew 710: <form name="loncapa_search" method="post" action="/adm/searchcat">
711: <center>
1.180 matthew 712: <hr />
1.187 www 713: <h1>$lt{'header'}</h1>
1.167 www 714: <input type="hidden" name="phase" value="course_search" />
715: $hidden_fields
716: <p>
1.187 www 717: $lt{'note'}.
1.167 www 718: </p>
719: <p>
720: <table>
721: <tr><td>
722: ENDCOURSESEARCH
1.180 matthew 723: $scrout.=' '.
1.200 www 724: &Apache::lonhtmlcommon::textbox('courseexp',
1.243 albertel 725: $env{'form.courseexp'},40);
1.180 matthew 726: my $crscheckbox =
1.200 www 727: &Apache::lonhtmlcommon::checkbox('crsfulltext',
1.243 albertel 728: $env{'form.crsfulltext'});
1.180 matthew 729: my $relcheckbox =
1.200 www 730: &Apache::lonhtmlcommon::checkbox('crsrelated',
1.243 albertel 731: $env{'form.crsrelated'});
1.231 raeburn 732: my $discheckbox =
733: &Apache::lonhtmlcommon::checkbox('crsdiscuss',
1.243 albertel 734: $env{'form.crsrelated'});
1.180 matthew 735: $scrout.=(<<ENDENDCOURSE);
1.167 www 736: </td></tr>
1.234 matthew 737: <tr><td><label>$relcheckbox $lt{'use'}</label></td><td></td></tr>
738: <tr><td><label>$crscheckbox $lt{'full'}</label></td><td></td></tr>
739: <tr><td><label>$discheckbox $lt{'disc'}</label></td><td></td></tr>
1.167 www 740: </table><p>
1.187 www 741: <input type="submit" name="coursesubmit" value='$lt{'srch'}' />
1.167 www 742: </p>
1.213 matthew 743: </center>
744: </form>
1.167 www 745: ENDENDCOURSE
1.180 matthew 746: }
1.256 albertel 747: $scrout .= &Apache::loncommon::end_page();
1.146 matthew 748: $r->print($scrout);
749: return;
1.124 matthew 750: }
1.276 raeburn 751:
752: sub setup_basic_search {
753: my ($r,$area,$hidden_fields,$closebutton) = @_;
754: # Define interface components
755: my %lt = &Apache::lonlocal::texthash (
756: res => 'LON-CAPA Catalog Search',
757: portfolio => 'Portfolio Search',
758: );
759: my ($userelatedwords,$onlysearchdomain,$inclext,$adv_search_link,$scrout);
760: $userelatedwords = '<label>'.&mt('[_1] use related words',
761: &Apache::lonhtmlcommon::checkbox('related',$env{'form.related'},'related')).
762: '</label>';
763: $onlysearchdomain = '<label>'.&mt('[_1] only search domain [_2]',
764: &Apache::lonhtmlcommon::checkbox('domains',$env{'form.domains'},
1.282 albertel 765: $r->dir_config('lonDefDomain')),
766: $r->dir_config('lonDefDomain')).
1.276 raeburn 767: '</label>';
768: $adv_search_link = '<a href="/adm/searchcat?'.
1.288 albertel 769: &Apache::loncommon::inhibit_menu_check().
1.309 bisitz 770: '&phase=disp_adv'.
771: '&catalogmode='.$env{'form.catalogmode'}.
772: '&launch='.$env{'form.launch'}.
773: '&mode='.$env{'form.mode'}.
774: '&area='.$area.
775: '&form='.$env{'form.form'}.
776: '&titleelement='.$env{'form.titleelement'}.
777: '&element='.$env{'form.element'}.
1.276 raeburn 778: '">'.&mt('Advanced Search').'</a>';
779: #
780: $scrout.='<form name="loncapa_search" method="post" '.
781: 'action="/adm/searchcat">'.
782: '<input type="hidden" name="phase" value="basic_search" />'.
783: $hidden_fields;
784: if (!exists($env{'form.area'})) {
785: $scrout .= '<input type="hidden" name="area" value="'.$area.'" />';
786: }
787: #
788: $scrout .= '<center>'.$/;
789: # if ($env{'request.course.id'}) {
790: $scrout .= '<h1>'.$lt{$area}.'</h1>';
791: # } else {
792: # No need to tell them they are searching
793: # $scrout.= ('<br />'x2);
794: # }
795: $scrout.='<table>'.
796: '<tr><td align="center" valign="top">'.
797: &Apache::lonhtmlcommon::textbox('basicexp',
798: $env{'form.basicexp'},50).
799: '<br />'.
800: '<font size="-1">'.&searchhelp().'</font>'.'</td>'.
801: '<td><font size="-1">'.
1.301 bisitz 802: '<span class="LC_nobreak">'.(' 'x3).$adv_search_link.'</span>'.'<br />'.
803: '<span class="LC_nobreak">'.(' 'x1).$userelatedwords.'</span>'.'<br />'.
804: '<span class="LC_nobreak">'.(' 'x1).$onlysearchdomain.'</span>'.'<br />'.
805: '<span class="LC_nobreak">'.(' 'x1).$inclext.'</span>'.'<br />'.
1.276 raeburn 806: '</font></td>'.
807: '</tr>'.$/;
808: #
809: $scrout .= '<tr><td align="center" colspan="2">'.
810: '<font size="-1">'.
811: '<input type="submit" name="basicsubmit" '.
812: 'value="'.&mt('Search').'" />'.
813: (' 'x2).$closebutton.(' 'x2). &viewoptions().
814: '</font>'.
815: '</td></tr>'.$/;
816: $scrout .= '</table>'.$/.'</center>'.'</form>';
817: return $scrout;
818: }
819:
1.124 matthew 820: ######################################################################
821: ######################################################################
822:
823: =pod
824:
825: =item &advanced_search_form()
826:
1.204 matthew 827: Prints the advanced search form.
1.124 matthew 828:
829: =cut
830:
831: ######################################################################
832: ######################################################################
1.146 matthew 833: sub print_advanced_search_form{
1.196 matthew 834: my ($r,$closebutton,$hidden_fields) = @_;
1.256 albertel 835: my $bread_crumb =
1.263 albertel 836: &Apache::lonhtmlcommon::breadcrumbs('Searching','Search_Advanced',
1.267 www 837: $env{'form.catalogmode'} ne 'import');
1.200 www 838: my %lt=&Apache::lonlocal::texthash('srch' => 'Search',
839: 'reset' => 'Reset',
840: 'help' => 'Help');
1.217 matthew 841: my $advanced_buttons=<<"END";
1.200 www 842: <input type="submit" name="advancedsubmit" value='$lt{"srch"}' />
843: <input type="reset" name="reset" value='$lt{"reset"}' />
1.129 matthew 844: $closebutton
845: END
1.277 raeburn 846: my $srchtype = 'Catalog';
1.279 raeburn 847: my $jscript;
1.277 raeburn 848: if ($env{'form.area'} eq 'portfolio') {
849: $srchtype = 'Portfolio';
1.279 raeburn 850: $jscript = '<script type="text/javascript">
851: function additional_metadata() {
852: if (document.advsearch.newfield.checked) {
853: document.advsearch.phase.value = "disp_adv";
854: document.advsearch.numaddedfields.value = parseInt(document.advsearch.numaddedfields.value) +1;
855: document.advsearch.submit();
1.277 raeburn 856: }
1.279 raeburn 857: }
858: </script>';
859: }
860: my $scrout= &Apache::loncommon::start_page("Advanced $srchtype Search",
861: $jscript);
1.207 matthew 862: $scrout .= <<"ENDHEADER";
1.256 albertel 863: $bread_crumb
1.200 www 864: <form method="post" action="/adm/searchcat" name="advsearch">
1.217 matthew 865: <p>
1.129 matthew 866: $advanced_buttons
1.124 matthew 867: ENDHEADER
1.208 matthew 868: $scrout.=(' 'x2).&viewoptions().'</p>'.$hidden_fields.
869: '<input type="hidden" name="phase" value="adv_search" />';
1.200 www 870: my %fields=&Apache::lonmeta::fieldnames();
1.208 matthew 871: #
1.289 bisitz 872: $scrout .= '<h3>'.&mt("Standard $srchtype Metadata").'</h3>';
1.217 matthew 873: $scrout .= "<table>\n";
874: $scrout .= '<tr><td> </td><td colspan="2"><font size="-1">'.
875: (' 'x2).&searchhelp()."</font></td></tr>\n";
1.208 matthew 876: my %related_word_search =
1.217 matthew 877: ('title' => 1,
878: 'author' => 0,
879: 'owner' => 0,
880: 'authorspace' => 0,
881: 'modifyinguser'=> 0,
882: 'keywords' => 1,
883: 'notes' => 1,
884: 'abstract' => 1,
885: 'standards'=> 1,
886: 'mime' => 1,
1.246 albertel 887: 'subject' => 1,
1.208 matthew 888: );
1.209 matthew 889: #
1.246 albertel 890: foreach my $field ('title','author','subject','owner','authorspace',
891: 'modifyinguser','keywords','notes','abstract',
892: 'standards','mime') {
1.208 matthew 893: $scrout.='<tr><td align="right">'.&titlefield($fields{$field}).'</td><td>'.
894: &Apache::lonmeta::prettyinput($field,
1.243 albertel 895: $env{'form.'.$field},
1.208 matthew 896: $field,
897: 'advsearch',
898: $related_word_search{$field},
899: '</td><td align="left">',
1.243 albertel 900: $env{'form.'.$field.'_related'},
1.208 matthew 901: 50);
902: if ($related_word_search{$field}) {
1.289 bisitz 903: $scrout .= &mt('related words');
1.208 matthew 904: } else {
905: $scrout .= '</td><td> ';
906: }
907: $scrout .= '</td></tr>'.$/;
908: }
909: foreach my $field ('lowestgradelevel','highestgradelevel') {
910: $scrout.='<tr>'.
911: '<td align="right">'.&titlefield($fields{$field}).'</td>'.
912: '<td colspan="2">'.
913: &Apache::lonmeta::prettyinput($field,
1.243 albertel 914: $env{'form.'.$field},
1.208 matthew 915: $field,
916: 'advsearch',
917: 0).
918: '</td></tr>'.$/;
1.200 www 919: }
1.208 matthew 920: $scrout.='<tr><td align="right">'.
921: &titlefield(&mt('MIME Type Category')).'</td><td colspan="2">'.
1.202 www 922: &Apache::loncommon::filecategoryselect('category',
1.243 albertel 923: $env{'form.category'}).
1.208 matthew 924: '</td></tr>'.$/;
925: $scrout.='<tr><td align="right" valign="top">'.
926: &titlefield(&mt('Domains')).'</td><td colspan="2">'.
1.202 www 927: &Apache::loncommon::domain_select('domains',
1.243 albertel 928: $env{'form.domains'},1).
1.310 ! bisitz 929: '<br />';
1.276 raeburn 930: $scrout .= '</td></tr>'.$/;
1.217 matthew 931: #
932: # Misc metadata
1.276 raeburn 933: if ($env{'form.area'} ne 'portfolio') {
934: $scrout.='<tr><td align="right" valign="top">'.
935: &titlefield(&mt('Copyright/Distribution')).
936: '</td><td colspan="2">'.
937: &Apache::lonmeta::selectbox('copyright',
938: $env{'form.copyright'},
939: \&Apache::loncommon::copyrightdescription,
940: ( undef,
941: &Apache::loncommon::copyrightids)
942: ).'</td></tr>'.$/;
943: }
1.217 matthew 944: $scrout.='<tr><td align="right" valign="top">'.
945: &titlefield(&mt('Language')).'</td><td colspan="2">'.
946: &Apache::lonmeta::selectbox('language',
1.243 albertel 947: $env{'form.language'},
1.217 matthew 948: \&Apache::loncommon::languagedescription,
949: ('any',&Apache::loncommon::languageids)
950: ).'</td></tr>';
1.276 raeburn 951: $scrout .= "</table>\n";
952:
953:
954: if ($env{'form.area'} eq 'portfolio') {
955: # Added fields
1.279 raeburn 956: my $curnumadd = $env{'form.numaddedfields'};
957: if ($curnumadd eq '') {
958: $curnumadd = 1;
959: }
1.276 raeburn 960: $scrout .= '<h3>'.&mt('Custom Metadata fields').'</h3>';
961: $scrout .= "<table>\n";
962: $scrout .= '<tr><td> </td><td align="center">'.
963: &mt('Field Name').'</td>'.'<td align="center">'.
1.279 raeburn 964: &mt('Field Value(s)').'</td></tr>';
965:
966: for (my $j=0; $j<$curnumadd; $j++) {
1.276 raeburn 967: my $num = $j+1;
968: $scrout .= '<tr><td>'.&mt('Custom metadata [_1]: ',$num).
969: '</td><td align="center">'.
970: '<input type="text" name="addedfield_'.$j.
1.279 raeburn 971: '" size="10" value="'.$env{'form.addedfield_'.$j}.
972: '" /></td>'.
1.276 raeburn 973: '<td align="center"><input type="text" '.
1.279 raeburn 974: 'name="addedvalues_'.$j.'" size="15" value="'.
975: $env{'form.addedvalues_'.$j}.'" /></td></tr>';
1.276 raeburn 976: }
1.279 raeburn 977: $scrout .= '<tr><td align="left" colspan="3"><label>'.
978: '<input type="checkbox" name="newfield" '.
979: 'value="1" onclick="javascript:additional_metadata()" />'.
980: &mt('Another custom field/value pair?').'</label>'.
981: '<input type="hidden" name="numaddedfields" value="'.
982: $curnumadd.'" /></td></tr></table>';
1.276 raeburn 983: } else {
984: #
985: # Dynamic metadata
986: $scrout .= '<h3>'.&mt('Problem Statistics').'</h3>';
987: $scrout .= "<table>\n";
988: $scrout .= '<tr><td> </td><td align="center">'.
989: &mt('Minimum').'</td>'.'<td align="center">'.
990: &mt('Maximum').'</td></tr>'."\n";
991: foreach my $statistic
992: ({ name=>'count',
993: description=>'Network-wide number of accesses (hits)',},
994: { name=>'stdno',
995: description=>
1.285 www 996: 'Statistics calculated for number of students',},
1.276 raeburn 997: { name => 'avetries',
998: description=>'Average number of tries till solved',},
999: { name => 'difficulty',
1000: description=>'Degree of difficulty',},
1001: { name => 'disc',
1002: description=>'Degree of discrimination'}) {
1003: $scrout .= '<tr><td align="right">'.
1004: &titlefield(&mt($statistic->{'description'})).
1005: '</td><td align="center">'.
1006: '<input type="text" name="'.$statistic->{'name'}.
1007: '_min" value="" size="6" /></td><td align="center">'.
1008: '<input type="text" name="'.$statistic->{'name'}.
1009: '_max" value="" size="6" /></td></tr>'.$/;
1010: }
1011: $scrout .= "</table>\n";
1012: $scrout .= '<h3>'.&mt('Evaluation Data').'</h3>';
1013: $scrout .= "<table>\n";
1014: $scrout .= '<tr><td> </td><td align="center">'.
1015: &mt('Minimum').'</td>'.'<td align="center">'.
1016: &mt('Maximum').'</td></tr>'."\n";
1017: foreach my $evaluation
1018: ( { name => 'clear',
1019: description => 'Material presented in clear way'},
1020: { name =>'depth',
1021: description => 'Material covered with sufficient depth'},
1022: { name => 'helpful',
1023: description => 'Material is helpful'},
1024: { name => 'correct',
1025: description => 'Material appears to be correct'},
1026: { name => 'technical',
1027: description => 'Resource is technically correct'}){
1028: $scrout .= '<tr><td align="right">'.
1029: &titlefield(&mt($evaluation->{'description'})).
1030: '</td><td align="center">'.
1031: '<input type="text" name="'.
1032: $evaluation->{'name'}.'_min" value="" size="6" />'.
1033: '</td><td align="center"><input type="text" name="'.
1034: $evaluation->{'name'}.'_max" value="" size="6" />'.
1035: '</td></tr>'.$/;
1036: }
1037: $scrout .= "</table>\n";
1.217 matthew 1038: }
1.216 matthew 1039: #
1040: # Creation/Modification date limits
1.217 matthew 1041: $scrout .= '<h3>'.&mt('Creation and Modification dates').'</h3>';
1.216 matthew 1042: $scrout .= "\n<table>\n";
1.292 raeburn 1043: $scrout .= "<tr><td> </td><td>".&mt('Month[_1]Day[_2]Year',' 'x14,' 'x6)."</td></tr>\n";
1.216 matthew 1044: my $cafter =
1045: &Apache::lonhtmlcommon::date_setter('advsearch', # formname
1046: 'creationdate1', # fieldname
1047: 0, # current value
1048: '', # special
1049: 1, # includeempty
1050: '', # state
1051: 1, # no_hh_mm_ss
1052: );
1053: my $cbefore =
1054: &Apache::lonhtmlcommon::date_setter('advsearch', # formname
1055: 'creationdate2', # fieldname
1056: 0, # current value
1057: '', # special
1058: 1, # includeempty
1059: '', # state
1060: 1, # no_hh_mm_ss
1061: );
1.290 bisitz 1062: $scrout .= '<tr><td align="right">'.&mt('Created between').'</td>'
1063: .'<td>'.$cafter.'</td></tr>'
1064: .'<tr><td align="right">'.&mt('and').'</td>'
1065: .'<td>'.$cbefore.'</td></tr>';
1.216 matthew 1066: my $lafter =
1067: &Apache::lonhtmlcommon::date_setter('advsearch',
1068: 'revisiondate1',
1069: 0, # current value
1070: '', # special
1071: 1, # includeempty
1072: '', # state
1073: 1, # no_hh_mm_ss
1074: );
1075: my $lbefore =
1076: &Apache::lonhtmlcommon::date_setter('advsearch',
1077: 'revisiondate2',
1078: 0, # current value
1079: '', # special
1080: 1, # includeempty
1081: '', # state
1082: 1, # no_hh_mm_ss
1083: );
1.290 bisitz 1084: $scrout .= '<tr><td align="right">'.&mt('Last modified between').'</td>'
1085: .'<td>'.$lafter.'</td></tr>'
1086: .'<tr><td align="right">'.&mt('and').'</td>'
1087: .'<td>'.$lbefore.'</td></tr>';
1.202 www 1088: $scrout.="</table>\n";
1.124 matthew 1089: $scrout.=<<ENDDOCUMENT;
1.129 matthew 1090: $advanced_buttons
1.8 harris41 1091: </form>
1092: ENDDOCUMENT
1.256 albertel 1093: $scrout .= &Apache::loncommon::end_page();
1.146 matthew 1094: $r->print($scrout);
1095: return;
1.124 matthew 1096: }
1.204 matthew 1097:
1.200 www 1098: ######################################################################
1099: ######################################################################
1100:
1101: =pod
1102:
1.204 matthew 1103: =item &titlefield()
1.200 www 1104:
1105: Inputs: title text
1106:
1107: Outputs: titletext with font wrapper
1108:
1109: =cut
1110:
1111: ######################################################################
1112: ######################################################################
1113: sub titlefield {
1114: my $title=shift;
1.208 matthew 1115: return $title;
1.200 www 1116: }
1.204 matthew 1117:
1.200 www 1118: ######################################################################
1119: ######################################################################
1120:
1121: =pod
1122:
1.204 matthew 1123: =item viewoptiontext()
1.200 www 1124:
1125: Inputs: codename for view option
1126:
1127: Outputs: displayed text
1128:
1129: =cut
1130:
1131: ######################################################################
1132: ######################################################################
1133: sub viewoptiontext {
1134: my $code=shift;
1.204 matthew 1135: my %desc=&Apache::lonlocal::texthash
1136: ('detailed' => "Detailed Citation View",
1137: 'xml' => 'XML/SGML',
1138: 'compact' => 'Compact View',
1139: 'fielded' => 'Fielded Format',
1.255 www 1140: 'summary' => 'Summary View',
1141: 'summarypreview' => 'Summary Preview',
1142: 'detailedpreview' => 'Detailed Citation Preview');
1.200 www 1143: return $desc{$code};
1144: }
1.204 matthew 1145:
1146: ######################################################################
1.200 www 1147: ######################################################################
1148:
1149: =pod
1150:
1.204 matthew 1151: =item viewoptions()
1.200 www 1152:
1153: Inputs: none
1154:
1155: Outputs: text for box with view options
1156:
1157: =cut
1158:
1159: ######################################################################
1160: ######################################################################
1161: sub viewoptions {
1.302 raeburn 1162: my $scrout = '<span class="LC_nobreak">';
1.243 albertel 1163: if (! defined($env{'form.viewselect'})) {
1164: $env{'form.viewselect'}='detailed';
1.208 matthew 1165: }
1.200 www 1166: $scrout.=&Apache::lonmeta::selectbox('viewselect',
1.243 albertel 1167: $env{'form.viewselect'},
1.200 www 1168: \&viewoptiontext,
1169: sort(keys(%Views)));
1.208 matthew 1170: $scrout.= ' ';
1.214 matthew 1171: my $countselect = &Apache::lonmeta::selectbox('show',
1.243 albertel 1172: $env{'form.show'},
1.214 matthew 1173: undef,
1174: (10,20,50,100,1000,10000));
1.301 bisitz 1175: $scrout .= (' 'x2)
1176: .&mt('[_1] Records per Page',$countselect)
1177: .'</span>'.$/;
1.200 www 1178: return $scrout;
1.201 www 1179: }
1180:
1181: ######################################################################
1.204 matthew 1182: ######################################################################
1.201 www 1183:
1184: =pod
1185:
1.204 matthew 1186: =item searchhelp()
1.201 www 1187:
1188: Inputs: none
1189:
1190: Outputs: return little blurb on how to enter searches
1191:
1192: =cut
1193:
1194: ######################################################################
1195: ######################################################################
1196: sub searchhelp {
1.228 matthew 1197: return &mt('Enter words and quoted phrases');
1.200 www 1198: }
1.8 harris41 1199:
1.121 matthew 1200: ######################################################################
1201: ######################################################################
1202:
1203: =pod
1204:
1.204 matthew 1205: =item &get_persistent_form_data()
1.145 matthew 1206:
1.146 matthew 1207: Inputs: filename of database
1208:
1209: Outputs: returns undef on database errors.
1210:
1211: This function is the reverse of &make_persistent() for form data.
1.145 matthew 1212: Retrieve persistent data from %persistent_db. Retrieved items will have their
1.243 albertel 1213: values unescaped. If a form value already exists in $env, it will not be
1.146 matthew 1214: overwritten. Form values that are array references may have values appended
1215: to them.
1.145 matthew 1216:
1217: =cut
1218:
1219: ######################################################################
1220: ######################################################################
1.146 matthew 1221: sub get_persistent_form_data {
1222: my $filename = shift;
1.147 matthew 1223: return 0 if (! -e $filename);
1.146 matthew 1224: return undef if (! tie(%persistent_db,'GDBM_File',$filename,
1.148 matthew 1225: &GDBM_READER(),0640));
1.146 matthew 1226: #
1227: # These make sure we do not get array references printed out as 'values'.
1.161 matthew 1228: my %arrays_allowed = ('form.domains'=>1);
1.146 matthew 1229: #
1230: # Loop through the keys, looking for 'form.'
1231: foreach my $name (keys(%persistent_db)) {
1232: next if ($name !~ /^form./);
1.182 matthew 1233: # Kludgification begins!
1234: if ($name eq 'form.domains' &&
1.243 albertel 1235: $env{'form.searchmode'} eq 'basic' &&
1236: $env{'form.phase'} ne 'disp_basic') {
1.182 matthew 1237: next;
1238: }
1239: # End kludge (hopefully)
1.243 albertel 1240: next if (exists($env{$name}));
1.146 matthew 1241: my @values = map {
1.265 www 1242: &unescape($_);
1.146 matthew 1243: } split(',',$persistent_db{$name});
1244: next if (@values <1);
1.152 matthew 1245: if ($arrays_allowed{$name}) {
1.243 albertel 1246: $env{$name} = [@values];
1.146 matthew 1247: } else {
1.243 albertel 1248: $env{$name} = $values[0] if ($values[0]);
1.146 matthew 1249: }
1250: }
1251: untie (%persistent_db);
1252: return 1;
1253: }
1.181 matthew 1254:
1.146 matthew 1255: ######################################################################
1256: ######################################################################
1257:
1258: =pod
1259:
1.204 matthew 1260: =item &get_persistent_data()
1.146 matthew 1261:
1262: Inputs: filename of database, ref to array of values to recover.
1263:
1264: Outputs: array of values. Returns undef on error.
1265:
1266: This function is the reverse of &make_persistent();
1267: Retrieve persistent data from %persistent_db. Retrieved items will have their
1268: values unescaped. If the item contains commas (before unescaping), the
1269: returned value will be an array pointer.
1270:
1271: =cut
1272:
1273: ######################################################################
1274: ######################################################################
1275: sub get_persistent_data {
1276: my $filename = shift;
1277: my @Vars = @{shift()};
1278: my @Values; # Return array
1279: return undef if (! -e $filename);
1280: return undef if (! tie(%persistent_db,'GDBM_File',$filename,
1.148 matthew 1281: &GDBM_READER(),0640));
1.146 matthew 1282: foreach my $name (@Vars) {
1283: if (! exists($persistent_db{$name})) {
1284: push @Values, undef;
1285: next;
1286: }
1287: my @values = map {
1.265 www 1288: &unescape($_);
1.146 matthew 1289: } split(',',$persistent_db{$name});
1.152 matthew 1290: if (@values <= 1) {
1.146 matthew 1291: push @Values,$values[0];
1.145 matthew 1292: } else {
1.146 matthew 1293: push @Values,\@values;
1.145 matthew 1294: }
1295: }
1.146 matthew 1296: untie (%persistent_db);
1297: return @Values;
1.145 matthew 1298: }
1299:
1300: ######################################################################
1301: ######################################################################
1302:
1303: =pod
1304:
1.121 matthew 1305: =item &make_persistent()
1306:
1.146 matthew 1307: Inputs: Hash of values to save, filename of persistent database.
1308:
1309: Store variables away to the %persistent_db.
1.145 matthew 1310: Values will be escaped. Values that are array pointers will have their
1.205 www 1311: elements escaped and concatenated in a comma separated string.
1.122 matthew 1312:
1.121 matthew 1313: =cut
1314:
1315: ######################################################################
1316: ######################################################################
1.98 harris41 1317: sub make_persistent {
1.133 matthew 1318: my %save = %{shift()};
1.146 matthew 1319: my $filename = shift;
1320: return undef if (! tie(%persistent_db,'GDBM_File',
1.148 matthew 1321: $filename,&GDBM_WRCREAT(),0640));
1.146 matthew 1322: foreach my $name (keys(%save)) {
1.145 matthew 1323: my @values = (ref($save{$name}) ? @{$save{$name}} : ($save{$name}));
1324: # We handle array references, but not recursively.
1.265 www 1325: my $store = join(',', map { &escape($_); } @values );
1.145 matthew 1326: $persistent_db{$name} = $store;
1.109 harris41 1327: }
1.146 matthew 1328: untie(%persistent_db);
1329: return 1;
1330: }
1331:
1332: ######################################################################
1333: ######################################################################
1334:
1335: =pod
1336:
1337: =item &make_form_data_persistent()
1338:
1339: Inputs: filename of persistent database.
1340:
1341: Store most form variables away to the %persistent_db.
1342: Values will be escaped. Values that are array pointers will have their
1.205 www 1343: elements escaped and concatenated in a comma separated string.
1.146 matthew 1344:
1345: =cut
1346:
1347: ######################################################################
1348: ######################################################################
1349: sub make_form_data_persistent {
1350: my $r = shift;
1351: my $filename = shift;
1352: my %save;
1.243 albertel 1353: foreach (keys(%env)) {
1.150 matthew 1354: next if (!/^form/ || /submit/);
1.243 albertel 1355: $save{$_} = $env{$_};
1.146 matthew 1356: }
1.152 matthew 1357: return &make_persistent(\%save,$filename);
1.98 harris41 1358: }
1359:
1.122 matthew 1360: ######################################################################
1361: ######################################################################
1362:
1363: =pod
1364:
1.134 matthew 1365: =item &parse_advanced_search()
1366:
1367: Parse advanced search form and return the following:
1368:
1369: =over 4
1370:
1371: =item $query Scalar containing an SQL query.
1.126 matthew 1372:
1.134 matthew 1373: =item $customquery Scalar containing a custom query.
1374:
1375: =item $customshow Scalar containing commands to show custom metadata.
1376:
1377: =item $libraries_to_query Reference to array of domains to search.
1378:
1379: =back
1.122 matthew 1380:
1381: =cut
1382:
1383: ######################################################################
1384: ######################################################################
1.134 matthew 1385: sub parse_advanced_search {
1.196 matthew 1386: my ($r,$closebutton,$hidden_fields)=@_;
1.216 matthew 1387: my @BasicFields = ('title','author','subject','keywords','url','version',
1.227 matthew 1388: 'notes','abstract','extension','owner','authorspace',
1.216 matthew 1389: # 'custommetadata','customshow',
1390: 'modifyinguser','standards','mime');
1.222 matthew 1391: my @StatsFields = &statfields();
1392: my @EvalFields = &evalfields();
1.32 harris41 1393: my $fillflag=0;
1.230 matthew 1394: my $pretty_search_string = "";
1.64 harris41 1395: # Clean up fields for safety
1.216 matthew 1396: for my $field (@BasicFields,
1397: 'creationdatestart_month','creationdatestart_day',
1.64 harris41 1398: 'creationdatestart_year','creationdateend_month',
1399: 'creationdateend_day','creationdateend_year',
1400: 'lastrevisiondatestart_month','lastrevisiondatestart_day',
1401: 'lastrevisiondatestart_year','lastrevisiondateend_month',
1.216 matthew 1402: 'lastrevisiondateend_day','lastrevisiondateend_year') {
1.300 raeburn 1403: $env{'form.'.$field}=~s/[^\w\/\s\(\)\=\-\"\'.\*]//g;
1.64 harris41 1404: }
1.117 matthew 1405: foreach ('mode','form','element') {
1406: # is this required? Hmmm.
1.243 albertel 1407: next if (! exists($env{'form.'.$_}));
1.265 www 1408: $env{'form.'.$_}=&unescape($env{'form.'.$_});
1.243 albertel 1409: $env{'form.'.$_}=~s/[^\w\/\s\(\)\=\-\"\']//g;
1.117 matthew 1410: }
1.131 matthew 1411: # Preprocess the category form element.
1.243 albertel 1412: $env{'form.category'} = 'any' if (! defined($env{'form.category'}) ||
1413: ref($env{'form.category'}));
1.161 matthew 1414: #
1.90 harris41 1415: # Check to see if enough information was filled in
1.222 matthew 1416: foreach my $field (@BasicFields) {
1.243 albertel 1417: if (&filled($env{'form.'.$field})) {
1.32 harris41 1418: $fillflag++;
1419: }
1420: }
1.222 matthew 1421: foreach my $field (@StatsFields,@EvalFields) {
1.243 albertel 1422: if (&filled($env{'form.'.$field.'_max'})) {
1.222 matthew 1423: $fillflag++;
1424: }
1.243 albertel 1425: if (&filled($env{'form.'.$field.'_min'})) {
1.222 matthew 1426: $fillflag++;
1427: }
1428: }
1429:
1.216 matthew 1430: for my $field ('lowestgradelevel','highestgradelevel') {
1.243 albertel 1431: if ( $env{'form.'.$field} =~ /^\d+$/ &&
1432: $env{'form.'.$field} > 0) {
1.216 matthew 1433: $fillflag++;
1434: }
1435: }
1.279 raeburn 1436: if ($env{'form.area'} eq 'portfolio') {
1437: # Added metadata fields
1438: for (my $i=0; $i<$env{'form.numaddedfields'} ; $i++) {
1439: my $field = $env{'form.addedfield_'.$i};
1440: $field =~ s/^\s*(\S*)\s*$/$1/;
1441: $field =~ s/\W/_/g;
1442: if ($field ne '') {
1443: $fillflag++;
1444: }
1445: }
1446: }
1.212 matthew 1447: if (! $fillflag) {
1.204 matthew 1448: &output_blank_field_error($r,$closebutton,
1449: 'phase=disp_adv',$hidden_fields);
1.134 matthew 1450: return ;
1.32 harris41 1451: }
1.90 harris41 1452: # Turn the form input into a SQL-based query
1.39 harris41 1453: my $query='';
1.45 harris41 1454: my @queries;
1.143 matthew 1455: my $font = '<font color="#800000" face="helvetica">';
1.90 harris41 1456: # Evaluate logical expression AND/OR/NOT phrase fields.
1.216 matthew 1457: foreach my $field (@BasicFields) {
1.243 albertel 1458: next if (!defined($env{'form.'.$field}) || $env{'form.'.$field} eq '');
1.228 matthew 1459: my ($error,$SQLQuery) =
1.243 albertel 1460: &process_phrase_input($env{'form.'.$field},
1461: $env{'form.'.$field.'_related'},$field);
1.228 matthew 1462: if (defined($error)) {
1463: &output_unparsed_phrase_error($r,$closebutton,'phase=disp_adv',
1464: $hidden_fields,$field);
1465: return;
1466: } else {
1467: $pretty_search_string .=
1.243 albertel 1468: $font.$field.'</font>: '.$env{'form.'.$field};
1469: if ($env{'form.'.$field.'_related'}) {
1.228 matthew 1470: my @Words =
1471: &Apache::loncommon::get_related_words
1.243 albertel 1472: ($env{'form.'.$field});
1.228 matthew 1473: if (@Words) {
1474: $pretty_search_string.= ' with related words: '.
1475: join(', ',@Words[0..4]);
1.143 matthew 1476: } else {
1.228 matthew 1477: $pretty_search_string.= ' with related words.';
1.143 matthew 1478: }
1.142 matthew 1479: }
1.228 matthew 1480: $pretty_search_string .= '<br />';
1481: push (@queries,$SQLQuery);
1.131 matthew 1482: }
1.44 harris41 1483: }
1.161 matthew 1484: #
1485: # Make the 'mime' from 'form.category' and 'form.extension'
1486: #
1487: my $searchphrase;
1.243 albertel 1488: if (exists($env{'form.category'}) &&
1489: $env{'form.category'} !~ /^\s*$/ &&
1490: $env{'form.category'} ne 'any') {
1.161 matthew 1491: my @extensions = &Apache::loncommon::filecategorytypes
1.243 albertel 1492: ($env{'form.category'});
1.161 matthew 1493: if (scalar(@extensions) > 0) {
1494: $searchphrase = join(' OR ',@extensions);
1495: }
1496: }
1497: if (defined($searchphrase)) {
1.228 matthew 1498: my ($error,$SQLsearch) = &process_phrase_input($searchphrase,0,'mime');
1499: push @queries,$SQLsearch;
1.161 matthew 1500: $pretty_search_string .=$font.'mime</font> contains <b>'.
1501: $searchphrase.'</b><br />';
1.135 matthew 1502: }
1.204 matthew 1503: #
1.90 harris41 1504: # Evaluate option lists
1.243 albertel 1505: if ($env{'form.lowestgradelevel'} &&
1506: $env{'form.lowestgradelevel'} ne '0' &&
1507: $env{'form.lowestgradelevel'} =~ /^\d+$/) {
1.216 matthew 1508: push(@queries,
1.243 albertel 1509: '(lowestgradelevel>='.$env{'form.lowestgradelevel'}.')');
1.216 matthew 1510: $pretty_search_string.="lowestgradelevel>=".
1.243 albertel 1511: $env{'form.lowestgradelevel'}."<br />\n";
1.216 matthew 1512: }
1.243 albertel 1513: if ($env{'form.highestgradelevel'} &&
1514: $env{'form.highestgradelevel'} ne '0' &&
1515: $env{'form.highestgradelevel'} =~ /^\d+$/) {
1.216 matthew 1516: push(@queries,
1.243 albertel 1517: '(highestgradelevel<='.$env{'form.highestgradelevel'}.')');
1.216 matthew 1518: $pretty_search_string.="highestgradelevel<=".
1.243 albertel 1519: $env{'form.highestgradelevel'}."<br />\n";
1.216 matthew 1520: }
1.243 albertel 1521: if ($env{'form.language'} and $env{'form.language'} ne 'any') {
1522: push @queries,"(language like \"$env{'form.language'}\")";
1.143 matthew 1523: $pretty_search_string.=$font."language</font>= ".
1.243 albertel 1524: &Apache::loncommon::languagedescription($env{'form.language'}).
1.143 matthew 1525: "<br />\n";
1.58 harris41 1526: }
1.243 albertel 1527: if ($env{'form.copyright'} and $env{'form.copyright'} ne 'any') {
1528: push @queries,"(copyright like \"$env{'form.copyright'}\")";
1.143 matthew 1529: $pretty_search_string.=$font."copyright</font> = ".
1.243 albertel 1530: &Apache::loncommon::copyrightdescription($env{'form.copyright'}).
1.230 matthew 1531: "<br />\n";
1.58 harris41 1532: }
1.276 raeburn 1533: if ($env{'form.area'} eq 'portfolio') {
1534: #
1535: # Added metadata fields
1536: for (my $i=0; $i<$env{'form.numaddedfields'} ; $i++) {
1.279 raeburn 1537: my $field = $env{'form.addedfield_'.$i};
1538: $field =~ s/^\s*(\S*)\s*$/$1/;
1539: $field =~ s/\W/_/g;
1540: $field =~ tr/A-Z/a-z/;
1541: if ($field ne '') {
1542: my $value = $env{'form.addedvalues_'.$i};
1543: if ($value ne '') {
1.280 albertel 1544: $value =~ s/'/''/g; #' stupid emacs
1.279 raeburn 1545: my ($error,$query) =
1546: &process_phrase_input($value,0,'pf.value');
1547: if (!defined($error)) {
1548: push(@queries,"pf.field = '$field' AND $query");
1549: $pretty_search_string .=
1550: $font.$field.'</font>: '.
1551: $env{'form.addedvalues_'.$i}.'<br />';
1552: }
1553: } else {
1554: push(@queries,"pf.field = '$field' AND pf.value IS NULL");
1555: }
1.276 raeburn 1556: }
1557: }
1558: } else {
1559: #
1560: # Statistics
1561: foreach my $field (@StatsFields,@EvalFields) {
1562: my ($min,$max);
1563: if (exists($env{'form.'.$field.'_min'}) &&
1564: $env{'form.'.$field.'_min'} ne '') {
1565: $min = $env{'form.'.$field.'_min'};
1566: }
1567: if (exists($env{'form.'.$field.'_max'}) &&
1568: $env{'form.'.$field.'_max'} ne '') {
1569: $max = $env{'form.'.$field.'_max'};
1570: }
1571: next if (! defined($max) && ! defined($min));
1572: if (defined($min) && defined($max)) {
1573: ($min,$max) = sort {$a <=>$b} ($min,$max);
1574: }
1575: if (defined($min) && $min =~ /^(\d+\.\d+|\d+|\.\d+)$/) {
1576: push(@queries,'('.$field.'>'.$min.')');
1577: $pretty_search_string.=$font.$field.'</font>>'.$min.'<br />';
1578: }
1579: if (defined($max) && $max =~ /^(\d+\.\d+|\d+|\.\d+)$/) {
1580: push(@queries,'('.$field.'<'.$max.')');
1581: $pretty_search_string.=$font.$field.'</font><'.$max.'<br />';
1582: }
1.217 matthew 1583: }
1584: }
1585: #
1.90 harris41 1586: # Evaluate date windows
1.216 matthew 1587: my $cafter =
1588: &Apache::lonhtmlcommon::get_date_from_form('creationdate1');
1589: my $cbefore =
1590: &Apache::lonhtmlcommon::get_date_from_form('creationdate2');
1591: if ($cafter > $cbefore) {
1592: my $tmp = $cafter;
1593: $cafter = $cbefore;
1594: $cbefore = $tmp;
1595: }
1596: my $mafter =
1597: &Apache::lonhtmlcommon::get_date_from_form('revisiondate1');
1598: my $mbefore =
1599: &Apache::lonhtmlcommon::get_date_from_form('revisiondate2');
1600: if ($mafter > $mbefore) {
1601: my $tmp = $mafter;
1602: $mafter = $mbefore;
1603: $mbefore = $tmp;
1604: }
1605: my ($datequery,$error,$prettydate)=&build_date_queries($cafter,$cbefore,
1606: $mafter,$mbefore);
1607: if (defined($error)) {
1608: &output_date_error($r,$error,$closebutton,$hidden_fields);
1609: } elsif (defined($datequery)) {
1.143 matthew 1610: # Here is where you would set up pretty_search_string to output
1611: # date query information.
1.216 matthew 1612: $pretty_search_string .= '<br />'.$prettydate.'<br />';
1.60 harris41 1613: push @queries,$datequery;
1614: }
1.204 matthew 1615: #
1.90 harris41 1616: # Process form information for custom metadata querying
1.134 matthew 1617: my $customquery=undef;
1.204 matthew 1618: ##
1619: ## The custom metadata search was removed q long time ago mostly
1620: ## because I was unable to figureout exactly how it worked and could
1621: ## not imagine people actually using it. MH
1622: ##
1.243 albertel 1623: # if ($env{'form.custommetadata'}) {
1.204 matthew 1624: # $pretty_search_string .=$font."Custom Metadata Search</font>: <b>".
1.243 albertel 1625: # $env{'form.custommetadata'}."</b><br />\n";
1.204 matthew 1626: # $customquery=&build_custommetadata_query('custommetadata',
1.243 albertel 1627: # $env{'form.custommetadata'});
1.204 matthew 1628: # }
1.134 matthew 1629: my $customshow=undef;
1.243 albertel 1630: # if ($env{'form.customshow'}) {
1.204 matthew 1631: # $pretty_search_string .=$font."Custom Metadata Display</font>: <b>".
1.243 albertel 1632: # $env{'form.customshow'}."</b><br />\n";
1633: # $customshow=$env{'form.customshow'};
1.204 matthew 1634: # $customshow=~s/[^\w\s]//g;
1635: # my @fields=split(/\s+/,$customshow);
1636: # $customshow=join(" ",@fields);
1637: # }
1638: ##
1.132 matthew 1639: ## Deal with restrictions to given domains
1640: ##
1.254 www 1641: my ($libraries_to_query,$pretty_domains_string) = &parse_domain_restrictions();
1642: if ($pretty_domains_string) {
1.251 www 1643: $pretty_search_string .= $pretty_domains_string."<br />\n";
1644: }
1.180 matthew 1645: #
1646: if (@queries) {
1.277 raeburn 1647: if ($env{'form.area'} eq 'portfolio') {
1.300 raeburn 1648: $query ="SELECT pm.*,pa.keynum,pa.scope FROM portfolio_metadata pm, portfolio_access pa, portfolio_addedfields pf WHERE (pm.url = pa.url AND pf.url = pm.url AND (pa.start < UTC_TIMESTAMP() AND (pa.end IS NULL OR pa.end > UTC_TIMESTAMP())) AND (".join(') AND (',@queries).'))';
1.277 raeburn 1649: } else {
1650: $query="SELECT * FROM metadata WHERE (".join(") AND (",@queries).')';
1651: }
1.180 matthew 1652: } elsif ($customquery) {
1653: $query = '';
1654: }
1.241 matthew 1655: #&Apache::lonnet::logthis('advanced query = '.$/.$query);
1.180 matthew 1656: return ($query,$customquery,$customshow,$libraries_to_query,
1657: $pretty_search_string);
1658: }
1659:
1660: sub parse_domain_restrictions {
1.132 matthew 1661: my $libraries_to_query = undef;
1.243 albertel 1662: # $env{'form.domains'} can be either a scalar or an array reference.
1.132 matthew 1663: # We need an array.
1.243 albertel 1664: if (! exists($env{'form.domains'}) || $env{'form.domains'} eq '') {
1.240 matthew 1665: return (undef,'',undef);
1.180 matthew 1666: }
1.245 albertel 1667: my @allowed_domains = &Apache::loncommon::get_env_multiple('form.domains');
1.204 matthew 1668: #
1.132 matthew 1669: my %domain_hash = ();
1.143 matthew 1670: my $pretty_domains_string;
1.132 matthew 1671: foreach (@allowed_domains) {
1672: $domain_hash{$_}++;
1673: }
1.143 matthew 1674: if ($domain_hash{'any'}) {
1.273 www 1675: $pretty_domains_string = &mt("in all LON-CAPA domains.");
1.143 matthew 1676: } else {
1677: if (@allowed_domains > 1) {
1.273 www 1678: $pretty_domains_string = &mt("in LON-CAPA domains:");
1.143 matthew 1679: } else {
1.273 www 1680: $pretty_domains_string = &mt("in LON-CAPA domain ");
1.143 matthew 1681: }
1682: foreach (sort @allowed_domains) {
1.152 matthew 1683: $pretty_domains_string .= "<b>".$_."</b> ";
1.132 matthew 1684: }
1.280 albertel 1685: my %servers = &Apache::lonnet::get_servers(\@allowed_domains,
1686: 'library');
1687: $libraries_to_query = [keys(%servers)];
1.132 matthew 1688: }
1.239 matthew 1689: return ($libraries_to_query,
1.254 www 1690: $pretty_domains_string);
1.18 harris41 1691: }
1692:
1.122 matthew 1693: ######################################################################
1694: ######################################################################
1695:
1696: =pod
1697:
1.134 matthew 1698: =item &parse_basic_search()
1.122 matthew 1699:
1.134 matthew 1700: Parse the basic search form and return a scalar containing an sql query.
1.126 matthew 1701:
1.122 matthew 1702: =cut
1703:
1704: ######################################################################
1705: ######################################################################
1.134 matthew 1706: sub parse_basic_search {
1.145 matthew 1707: my ($r,$closebutton)=@_;
1.204 matthew 1708: #
1.64 harris41 1709: # Clean up fields for safety
1710: for my $field ('basicexp') {
1.300 raeburn 1711: $env{"form.$field"}=~s/[^\w\s\'\"\!\(\)\-\*]//g;
1.64 harris41 1712: }
1.117 matthew 1713: foreach ('mode','form','element') {
1714: # is this required? Hmmm.
1.243 albertel 1715: next unless (exists($env{"form.$_"}));
1.265 www 1716: $env{"form.$_"}=&unescape($env{"form.$_"});
1.243 albertel 1717: $env{"form.$_"}=~s/[^\w\/\s\(\)\=\-\"\']//g;
1.117 matthew 1718: }
1.254 www 1719: my ($libraries_to_query,$pretty_domains_string) = &parse_domain_restrictions();
1.204 matthew 1720: #
1721: # Check to see if enough of a query is filled in
1.243 albertel 1722: my $search_string = $env{'form.basicexp'};
1.220 matthew 1723: if (! &filled($search_string)) {
1.151 matthew 1724: &output_blank_field_error($r,$closebutton,'phase=disp_basic');
1.24 harris41 1725: return OK;
1726: }
1.228 matthew 1727: my $pretty_search_string=$search_string;
1.224 matthew 1728: my @Queries;
1.276 raeburn 1729: my @fields = ('title','author','subject','notes','abstract','keywords');
1730: my $searchfield;
1731: if ($env{'form.area'} eq 'portfolio') {
1732: $searchfield = 'concat_ws(" ",pm.'.join(',pm.',@fields).')';
1733: } else {
1734: $searchfield = 'concat_ws(" ",'.join(',',@fields).')';
1735: }
1.228 matthew 1736: my ($error,$SQLQuery) = &process_phrase_input($search_string,
1.243 albertel 1737: $env{'form.related'},
1.228 matthew 1738: $searchfield);
1739: if ($error) {
1740: &output_unparsed_phrase_error($r,$closebutton,'phase=disp_basic',
1741: '','basicexp');
1742: return;
1.141 matthew 1743: }
1.228 matthew 1744: push(@Queries,$SQLQuery);
1745: #foreach my $q (@Queries) {
1746: # &Apache::lonnet::logthis(' '.$q);
1747: #}
1.276 raeburn 1748: my $final_query;
1749: if ($env{'form.area'} eq 'portfolio') {
1.300 raeburn 1750: $final_query = 'SELECT pm.*,pa.keynum,pa.scope FROM portfolio_metadata pm, portfolio_access pa WHERE (pm.url = pa.url AND (pa.start < UTC_TIMESTAMP() AND (pa.end IS NULL OR pa.end > UTC_TIMESTAMP())) AND '.join(" AND ",@Queries).')';
1.276 raeburn 1751: } else {
1752: $final_query = 'SELECT * FROM metadata WHERE '.join(" AND ",@Queries);
1753: }
1.204 matthew 1754: #
1.273 www 1755: if ($env{'form.related'}) {
1756: $pretty_search_string.=' '.&mt('(including related words)');
1757: }
1.180 matthew 1758: if (defined($pretty_domains_string) && $pretty_domains_string ne '') {
1759: $pretty_search_string .= ' '.$pretty_domains_string;
1760: }
1.143 matthew 1761: $pretty_search_string .= "<br />\n";
1.225 matthew 1762: $pretty_search_string =~ s:^<br /> and ::;
1.276 raeburn 1763: &Apache::lonnet::logthis('simple search final query = '.$/.$final_query);
1.183 matthew 1764: return ($final_query,$pretty_search_string,
1.180 matthew 1765: $libraries_to_query);
1.22 harris41 1766: }
1767:
1.228 matthew 1768:
1769: ###############################################################
1770: ###############################################################
1771:
1772: my @Phrases;
1773:
1774: sub concat {
1775: my ($item) = @_;
1776: my $results = '';
1777: foreach (@$item) {
1778: if (ref($_) eq 'ARRAY') {
1779: $results .= join(' ',@$_);
1780: }
1781: }
1782: return $results;
1783: }
1784:
1.224 matthew 1785: sub process_phrase_input {
1.228 matthew 1786: my ($phrase,$related,$field)=@_;
1787: #&Apache::lonnet::logthis('phrase = :'.$phrase.':');
1788: my $grammar = <<'ENDGRAMMAR';
1789: searchphrase:
1790: expression /^\Z/ {
1791: # &Apache::lonsearchcat::print_item(\@item,0);
1792: [@item];
1793: }
1794: expression:
1795: phrase(s) {
1796: [@item];
1797: }
1798: phrase:
1799: orword {
1800: [@item];
1801: }
1802: | andword {
1803: [@item];
1804: }
1805: | minusword {
1806: unshift(@::Phrases,$item[1]->[0]);
1807: unshift(@::Phrases,$item[1]->[1]);
1808: [@item];
1809: }
1810: | word {
1811: unshift(@::Phrases,$item[1]);
1812: [@item];
1813: }
1814: #
1815: orword:
1816: word 'OR' phrase {
1817: unshift(@::Phrases,'OR');
1818: unshift(@::Phrases,$item[1]);
1819: [@item];
1820: }
1821: | word 'or' phrase {
1822: unshift(@::Phrases,'OR');
1823: unshift(@::Phrases,$item[1]);
1824: [@item];
1825: }
1826: | minusword 'OR' phrase {
1827: unshift(@::Phrases,'OR');
1828: unshift(@::Phrases,$item[1]->[0]);
1829: unshift(@::Phrases,$item[1]->[1]);
1830: [@item];
1831: }
1832: | minusword 'or' phrase {
1833: unshift(@::Phrases,'OR');
1834: unshift(@::Phrases,$item[1]->[0]);
1835: unshift(@::Phrases,$item[1]->[1]);
1836: [@item];
1837: }
1838: andword:
1839: word phrase {
1840: unshift(@::Phrases,'AND');
1841: unshift(@::Phrases,$item[1]);
1842: [@item];
1843: }
1844: | minusword phrase {
1845: unshift(@::Phrases,'AND');
1846: unshift(@::Phrases,$item[1]->[0]);
1847: unshift(@::Phrases,$item[1]->[1]);
1848: [@item];
1849: }
1850: #
1851: minusword:
1852: '-' word {
1853: [$item[2],'NOT'];
1854: }
1855: word:
1856: "'" term(s) "'" {
1857: &Apache::lonsearchcat::concat(\@item);
1858: }
1859: | '"' term(s) '"' {
1860: &Apache::lonsearchcat::concat(\@item);
1861: }
1862: | term {
1863: $item[1];
1864: }
1865: term:
1.284 albertel 1866: /[\w\Q:!@#$%^&*()+_=|{}<>,.;\\\/?\E\-]+/ {
1.228 matthew 1867: $item[1];
1868: }
1869: ENDGRAMMAR
1870: #
1871: # The end result of parsing the phrase with the grammar is an array
1872: # @::Phrases.
1873: # $phrase = "gene splicing" or cat -> "gene splicing","OR","cat"
1874: # $phrase = "genetic engineering" -dna ->
1875: # "genetic engineering","AND","NOT","dna"
1876: # $phrase = cat or dog -poodle -> "cat","OR","dog","AND","NOT","poodle"
1877: undef(@::Phrases);
1878: my $p = new Parse::RecDescent($grammar);
1879: if (! defined($p->searchphrase($phrase))) {
1880: &Apache::lonnet::logthis('lonsearchcat:unable to process:'.$phrase);
1881: return 'Unable to process phrase '.$phrase;
1882: }
1883: #
1884: # Go through the phrases and make sense of them.
1885: # Apply modifiers NOT OR and AND to the phrases.
1886: my @NewPhrases;
1887: while(@::Phrases) {
1888: my $phrase = shift(@::Phrases);
1889: # &Apache::lonnet::logthis('phrase = '.$phrase);
1890: my $phrasedata;
1891: if ($phrase =~ /^(NOT|OR|AND)$/) {
1892: if ($phrase eq 'OR') {
1893: $phrasedata->{'or'}++;
1894: if (! @::Phrases) { $phrasedata = undef; last; }
1895: $phrase = shift(@::Phrases);
1896: } elsif ($phrase eq 'AND') {
1897: $phrasedata->{'and'}++;
1898: if (! @::Phrases) { $phrasedata = undef; last; }
1899: $phrase = shift(@::Phrases);
1.224 matthew 1900: }
1.228 matthew 1901: if ($phrase eq 'NOT') {
1902: $phrasedata->{'negate'}++;
1903: if (! @::Phrases) { $phrasedata = undef; last; }
1904: $phrase = shift(@::Phrases);
1.224 matthew 1905: }
1.228 matthew 1906: }
1907: $phrasedata->{'phrase'} = $phrase;
1908: if ($related) {
1909: my @NewWords;
1910: (undef,@NewWords) = &related_version($phrasedata->{'phrase'});
1911: $phrasedata->{'related_words'} = \@NewWords;
1912: }
1913: push(@NewPhrases,$phrasedata);
1914: }
1915: #
1916: # Actually build the sql query from the phrases
1917: my $SQLQuery;
1918: foreach my $phrase (@NewPhrases) {
1919: my $query;
1920: if ($phrase->{'negate'}) {
1921: $query .= $field.' NOT LIKE "%'.$phrase->{'phrase'}.'%"';
1.224 matthew 1922: } else {
1.228 matthew 1923: $query .= $field.' LIKE "%'.$phrase->{'phrase'}.'%"';
1924: }
1925: foreach my $related (@{$phrase->{'related_words'}}) {
1926: if ($phrase->{'negate'}) {
1927: $query .= ' AND '.$field.' NOT LIKE "%'.$related.'%"';
1928: } else {
1929: $query .= ' OR '.$field.' LIKE "%'.$related.'%"';
1930: }
1931: }
1932: if ($SQLQuery) {
1933: if ($phrase->{'or'}) {
1934: $SQLQuery .= ' OR ('.$query.')';
1935: } else {
1936: $SQLQuery .= ' AND ('.$query.')';
1.224 matthew 1937: }
1.228 matthew 1938: } else {
1939: $SQLQuery = '('.$query.')';
1.224 matthew 1940: }
1941: }
1942: #
1.228 matthew 1943: # &Apache::lonnet::logthis("SQLQuery = $SQLQuery");
1.224 matthew 1944: #
1.228 matthew 1945: return undef,$SQLQuery;
1.224 matthew 1946: }
1947:
1.122 matthew 1948: ######################################################################
1949: ######################################################################
1950:
1951: =pod
1952:
1.204 matthew 1953: =item &related_version()
1.142 matthew 1954:
1955: Modifies an input string to include related words. Words in the string
1956: are replaced with parenthesized lists of 'OR'd words. For example
1957: "torque" is replaced with "(torque OR word1 OR word2 OR ...)".
1958:
1959: Note: Using this twice on a string is probably silly.
1960:
1961: =cut
1962:
1963: ######################################################################
1964: ######################################################################
1965: sub related_version {
1.224 matthew 1966: my ($word) = @_;
1967: return (undef) if (lc($word) =~ /\b(or|and|not)\b/);
1968: my @Words = &Apache::loncommon::get_related_words($word);
1969: # Only use 4 related words
1970: @Words = ($#Words>4? @Words[0..4] : @Words);
1971: my $result = join " OR ", ($word,@Words);
1972: return $result,sort(@Words);
1.142 matthew 1973: }
1974:
1.98 harris41 1975:
1.122 matthew 1976: ######################################################################
1977: ######################################################################
1978:
1979: =pod
1980:
1981: =item &build_custommetadata_query()
1982:
1.126 matthew 1983: Constructs a custom metadata query using a rather heinous regular
1984: expression.
1985:
1.122 matthew 1986: =cut
1987:
1988: ######################################################################
1989: ######################################################################
1.98 harris41 1990: sub build_custommetadata_query {
1991: my ($field_name,$logic_statement)=@_;
1992: my $q=new Text::Query('abc',
1993: -parse => 'Text::Query::ParseAdvanced',
1994: -build => 'Text::Query::BuildAdvancedString');
1995: $q->prepare($logic_statement);
1996: my $matchexp=${$q}{'-parse'}{'-build'}{'matchstring'};
1997: # quick fix to change literal into xml tag-matching
1998: # will eventually have to write a separate builder module
1.122 matthew 1999: # wordone=wordtwo becomes\<wordone\>[^\<] *wordtwo[^\<]*\<\/wordone\>
2000: $matchexp =~ s/(\w+)\\=([\w\\\+]+)?# wordone=wordtwo is changed to
2001: /\\<$1\\>?# \<wordone\>
2002: \[\^\\<\]?# [^\<]
2003: \*$2\[\^\\<\]?# *wordtwo[^\<]
2004: \*\\<\\\/$1\\>?# *\<\/wordone\>
2005: /g;
1.98 harris41 2006: return $matchexp;
2007: }
2008:
1.22 harris41 2009:
1.122 matthew 2010: ######################################################################
2011: ######################################################################
2012:
2013: =pod
2014:
2015: =item &build_date_queries()
2016:
1.126 matthew 2017: Builds a SQL logic query to check time/date entries.
2018: Also reports errors (check for /^Incorrect/).
2019:
1.122 matthew 2020: =cut
2021:
2022: ######################################################################
2023: ######################################################################
1.98 harris41 2024: sub build_date_queries {
1.216 matthew 2025: my ($cafter,$cbefore,$mafter,$mbefore) = @_;
2026: my ($result,$error,$pretty_string);
2027: #
2028: # Verify the input
2029: if (! defined($cafter) && ! defined($cbefore) &&
2030: ! defined($mafter) && ! defined($mbefore)) {
2031: # This is an okay situation, so return undef for the error
2032: return (undef,undef,undef);
2033: }
2034: if ((defined($cafter) && ! defined($cbefore)) ||
2035: (defined($cbefore) && ! defined($cafter))) {
2036: # This is bad, so let them know
2037: $error = &mt('Incorrect entry for the creation date. '.
2038: 'You must specify both the beginning and ending dates.');
2039: }
2040: if (! defined($error) &&
2041: ((defined($mafter) && ! defined($mbefore)) ||
2042: (defined($mbefore) && ! defined($mafter)))) {
2043: # This is also bad, so let them know
2044: $error = &mt('Incorrect entry for the last revision date. '.
2045: 'You must specify both the beginning and ending dates.');
1.98 harris41 2046: }
1.216 matthew 2047: if (! defined($error)) {
2048: #
2049: # Build the queries
2050: my @queries;
2051: if (defined($cbefore) && defined($cafter)) {
2052: my (undef,undef,undef,$caday,$camon,$cayear) = localtime($cafter);
2053: my (undef,undef,undef,$cbday,$cbmon,$cbyear) = localtime($cbefore);
2054: # Correct for year being relative to 1900
2055: $cayear+=1900; $cbyear+=1900;
2056: my $cquery=
2057: '(creationdate BETWEEN '.
2058: "'".$cayear.'-'.$camon.'-'.$caday."'".
2059: ' AND '.
2060: "'".$cbyear.'-'.$cbmon.'-'.$cbday." 23:59:59')";
2061: $pretty_string .= '<br />' if (defined($pretty_string));
2062: $pretty_string .=
2063: &mt('created between [_1] and [_2]',
2064: &Apache::lonlocal::locallocaltime($cafter),
2065: &Apache::lonlocal::locallocaltime($cbefore+24*60*60-1));
2066: push(@queries,$cquery);
2067: $pretty_string =~ s/ 00:00:00//g;
2068: }
2069: if (defined($mbefore) && defined($mafter)) {
2070: my (undef,undef,undef,$maday,$mamon,$mayear) = localtime($mafter);
2071: my (undef,undef,undef,$mbday,$mbmon,$mbyear) = localtime($mbefore);
2072: # Correct for year being relative to 1900
2073: $mayear+=1900; $mbyear+=1900;
2074: my $mquery=
2075: '(lastrevisiondate BETWEEN '.
2076: "'".$mayear.'-'.$mamon.'-'.$maday."'".
2077: ' AND '.
2078: "'".$mbyear.'-'.$mbmon.'-'.$mbday." 23:59:59')";
2079: push(@queries,$mquery);
2080: $pretty_string .= '<br />' if (defined($pretty_string));
2081: $pretty_string .=
2082: &mt('last revised between [_1] and [_2]',
2083: &Apache::lonlocal::locallocaltime($mafter),
2084: &Apache::lonlocal::locallocaltime($mbefore+24*60*60-1));
2085: $pretty_string =~ s/ 00:00:00//g;
2086: }
2087: if (@queries) {
2088: $result .= join(" AND ",@queries);
2089: }
1.98 harris41 2090: }
1.216 matthew 2091: return ($result,$error,$pretty_string);
1.18 harris41 2092: }
1.6 harris41 2093:
1.122 matthew 2094: ######################################################################
2095: ######################################################################
2096:
1.144 matthew 2097: =pod
2098:
2099: =item ©right_check()
2100:
1.204 matthew 2101: Inputs: $Metadata, a hash pointer of metadata for a resource.
2102:
2103: Returns: 1 if the resource is available to the user making the query,
2104: 0 otherwise.
2105:
1.144 matthew 2106: =cut
2107:
2108: ######################################################################
2109: ######################################################################
2110: sub copyright_check {
2111: my $Metadata = shift;
2112: # Check copyright tags and skip results the user cannot use
2113: my (undef,undef,$resdom,$resname) = split('/',
2114: $Metadata->{'url'});
2115: # Check for priv
2116: if (($Metadata->{'copyright'} eq 'priv') &&
1.243 albertel 2117: (($env{'user.name'} ne $resname) &&
2118: ($env{'user.domain'} ne $resdom))) {
1.144 matthew 2119: return 0;
2120: }
2121: # Check for domain
2122: if (($Metadata->{'copyright'} eq 'domain') &&
1.243 albertel 2123: ($env{'user.domain'} ne $resdom)) {
1.144 matthew 2124: return 0;
2125: }
1.294 www 2126: # Check for custom rights
2127: if ($Metadata->{'copyright'} eq 'custom') {
1.296 raeburn 2128: return &Apache::lonnet::customaccess('bre',$Metadata->{'url'});
1.294 www 2129: }
1.144 matthew 2130: return 1;
2131: }
2132:
1.151 matthew 2133: ######################################################################
2134: ######################################################################
2135:
2136: =pod
2137:
1.204 matthew 2138: =item &ensure_db_and_table()
1.151 matthew 2139:
2140: Ensure we can get lonmysql to connect to the database and the table we
2141: need exists.
2142:
2143: Inputs: $r, table id
2144:
2145: Returns: undef on error, 1 if the table exists.
2146:
2147: =cut
2148:
2149: ######################################################################
2150: ######################################################################
2151: sub ensure_db_and_table {
2152: my ($r,$table) = @_;
2153: ##
2154: ## Sanity check the table id.
2155: ##
2156: if (! defined($table) || $table eq '' || $table =~ /\D/ ) {
2157: $r->print("Unable to retrieve search results. ".
1.286 albertel 2158: "Unable to determine the table results were saved in. ".
1.256 albertel 2159: &Apache::loncommon::end_page());
1.151 matthew 2160: return undef;
2161: }
2162: ##
2163: ## Make sure we can connect and the table exists.
2164: ##
2165: my $connection_result = &Apache::lonmysql::connect_to_db();
2166: if (!defined($connection_result)) {
2167: $r->print("Unable to connect to the MySQL database where your results".
1.286 albertel 2168: " are saved.".
1.256 albertel 2169: &Apache::loncommon::end_page());
1.151 matthew 2170: &Apache::lonnet::logthis("lonsearchcat: unable to get lonmysql to".
2171: " connect to database.");
2172: &Apache::lonnet::logthis(&Apache::lonmysql::get_error());
2173: return undef;
2174: }
2175: my $table_check = &Apache::lonmysql::check_table($table);
2176: if (! defined($table_check)) {
1.256 albertel 2177: $r->print("A MySQL error has occurred.</form>".
2178: &Apache::loncommon::end_page());
1.151 matthew 2179: &Apache::lonnet::logthis("lonmysql was unable to determine the status".
2180: " of table ".$table);
2181: return undef;
2182: } elsif (! $table_check) {
2183: $r->print("The table of results could not be found.");
2184: &Apache::lonnet::logthis("The user requested a table, ".$table.
2185: ", that could not be found.");
2186: return undef;
2187: }
2188: return 1;
2189: }
2190:
2191: ######################################################################
2192: ######################################################################
2193:
2194: =pod
2195:
1.204 matthew 2196: =item &print_sort_form()
2197:
2198: The sort feature is not implemented at this time. This form just prints
2199: a link to change the search query.
1.151 matthew 2200:
2201: =cut
2202:
2203: ######################################################################
2204: ######################################################################
2205: sub print_sort_form {
2206: my ($r,$pretty_query_string) = @_;
1.224 matthew 2207:
1.151 matthew 2208: ##
1.187 www 2209: my %SortableFields=&Apache::lonlocal::texthash(
2210: id => 'Default',
1.151 matthew 2211: title => 'Title',
2212: author => 'Author',
2213: subject => 'Subject',
2214: url => 'URL',
2215: version => 'Version Number',
2216: mime => 'Mime type',
2217: lang => 'Language',
2218: owner => 'Owner/Publisher',
2219: copyright => 'Copyright',
2220: hostname => 'Host',
2221: creationdate => 'Creation Date',
1.187 www 2222: lastrevisiondate => 'Revision Date'
1.151 matthew 2223: );
2224: ##
1.243 albertel 2225: my $table = $env{'form.table'};
1.151 matthew 2226: return if (! &ensure_db_and_table($r,$table));
2227: ##
2228: ## Get the number of results
2229: ##
2230: my $total_results = &Apache::lonmysql::number_of_rows($table);
2231: if (! defined($total_results)) {
1.256 albertel 2232: $r->print("A MySQL error has occurred.</form>".
2233: &Apache::loncommon::end_page());
1.151 matthew 2234: &Apache::lonnet::logthis("lonmysql was unable to determine the number".
2235: " of rows in table ".$table);
2236: &Apache::lonnet::logthis(&Apache::lonmysql::get_error());
2237: return;
2238: }
1.257 albertel 2239: my $js =<<END;
2240: <script type="text/javascript">
1.151 matthew 2241: function change_sort() {
2242: var newloc = "/adm/searchcat?phase=results";
1.309 bisitz 2243: newloc += "&persistent_db_id=$env{'form.persistent_db_id'}";
2244: newloc += "&sortby=";
1.151 matthew 2245: newloc += document.forms.statusform.elements.sortby.value;
2246: parent.resultsframe.location= newloc;
2247: }
2248: </script>
1.257 albertel 2249: END
2250:
1.307 bisitz 2251: my $start_page = &Apache::loncommon::start_page('Results',$js);
1.257 albertel 2252: my $breadcrumbs=
1.263 albertel 2253: &Apache::lonhtmlcommon::breadcrumbs('Searching','Searching',
1.267 www 2254: $env{'form.catalogmode'} ne 'import');
1.257 albertel 2255:
2256: my $result = <<END;
2257: $start_page
2258: $breadcrumbs
1.267 www 2259: <form name="statusform" action="" method="post" target="_top">
1.268 www 2260: <input type="hidden" name="catalogmode" value="import" />
1.270 www 2261: <input type="hidden" name="acts" value="" />
1.151 matthew 2262: END
2263:
2264: #<h2>Sort Results</h2>
2265: #Sort by: <select size="1" name="sortby" onchange="javascript:change_sort();">
1.243 albertel 2266: # $env{'form.sortby'} = 'id' if (! defined($env{'form.sortby'}));
1.151 matthew 2267: # foreach (keys(%SortableFields)) {
2268: # $result.="<option name=\"$_\"";
1.243 albertel 2269: # if ($_ eq $env{'form.sortby'}) {
1.151 matthew 2270: # $result.=" selected ";
2271: # }
2272: # $result.=" >$SortableFields{$_}</option>\n";
2273: # }
2274: # $result.="</select>\n";
2275: my $revise = &revise_button();
1.289 bisitz 2276: $result.='<p>'
2277: .&mt('There are [_1] matches to your query.',$total_results)
2278: .' '.$revise.'</p>'
2279: .'<p>'.&mt('Search: ').$pretty_query_string
2280: .'</p></form>';
1.256 albertel 2281: $r->print($result.&Apache::loncommon::end_page());
1.151 matthew 2282: return;
2283: }
2284:
1.144 matthew 2285: #####################################################################
2286: #####################################################################
2287:
2288: =pod
2289:
2290: =item MySQL Table Description
2291:
2292: MySQL table creation requires a precise description of the data to be
2293: stored. The use of the correct types to hold data is vital to efficient
2294: storage and quick retrieval of records. The columns must be described in
2295: the following format:
2296:
2297: =cut
2298:
1.170 matthew 2299: #####################################################################
2300: #####################################################################
1.204 matthew 2301: #
2302: # These should probably be scoped but I don't have time right now...
2303: #
2304: my @Datatypes;
2305: my @Fullindicies;
1.147 matthew 2306:
1.144 matthew 2307: ######################################################################
2308: ######################################################################
2309:
2310: =pod
2311:
1.146 matthew 2312: =item &create_results_table()
2313:
2314: Creates the table of search results by calling lonmysql. Stores the
1.243 albertel 2315: table id in $env{'form.table'}
1.146 matthew 2316:
1.276 raeburn 2317: Inputs: search area - either res or portfolio
1.146 matthew 2318:
2319: Returns: the identifier of the table on success, undef on error.
2320:
2321: =cut
2322:
2323: ######################################################################
2324: ######################################################################
1.204 matthew 2325: sub set_up_table_structure {
1.276 raeburn 2326: my ($tabletype) = @_;
1.204 matthew 2327: my ($datatypes,$fullindicies) =
1.276 raeburn 2328: &LONCAPA::lonmetadata::describe_metadata_storage($tabletype);
1.212 matthew 2329: # Copy the table description before modifying it...
2330: @Datatypes = @{$datatypes};
2331: unshift(@Datatypes,{name => 'id',
1.204 matthew 2332: type => 'MEDIUMINT',
2333: restrictions => 'UNSIGNED NOT NULL',
2334: primary_key => 'yes',
2335: auto_inc => 'yes' });
2336: @Fullindicies = @{$fullindicies};
2337: return;
2338: }
2339:
1.146 matthew 2340: sub create_results_table {
1.276 raeburn 2341: my ($area) = @_;
2342: if ($area eq 'portfolio') {
2343: &set_up_table_structure('portfolio_search');
2344: } else {
2345: &set_up_table_structure('metadata');
2346: }
1.146 matthew 2347: my $table = &Apache::lonmysql::create_table
1.170 matthew 2348: ( { columns => \@Datatypes,
1.172 matthew 2349: FULLTEXT => [{'columns' => \@Fullindicies},],
1.146 matthew 2350: } );
2351: if (defined($table)) {
1.243 albertel 2352: $env{'form.table'} = $table;
1.146 matthew 2353: return $table;
2354: }
2355: return undef; # Error...
2356: }
1.148 matthew 2357:
1.146 matthew 2358: ######################################################################
2359: ######################################################################
2360:
2361: =pod
2362:
1.150 matthew 2363: =item Search Status update functions
1.144 matthew 2364:
1.150 matthew 2365: Each of the following functions changes the values of one of the
2366: input fields used to display the search status to the user. The names
2367: should be explanatory.
1.144 matthew 2368:
1.150 matthew 2369: Inputs: Apache request handler ($r), text to display.
1.148 matthew 2370:
1.150 matthew 2371: Returns: Nothing.
1.148 matthew 2372:
2373: =over 4
2374:
2375: =item &update_count_status()
2376:
1.150 matthew 2377: =item &update_status()
1.148 matthew 2378:
1.150 matthew 2379: =item &update_seconds()
1.148 matthew 2380:
2381: =back
2382:
2383: =cut
2384:
2385: ######################################################################
2386: ######################################################################
2387: sub update_count_status {
2388: my ($r,$text) = @_;
2389: $text =~ s/\'/\\\'/g;
2390: $r->print
2391: ("<script>document.statusform.count.value = ' $text'</script>\n");
2392: $r->rflush();
2393: }
2394:
1.150 matthew 2395: sub update_status {
1.148 matthew 2396: my ($r,$text) = @_;
2397: $text =~ s/\'/\\\'/g;
2398: $r->print
1.150 matthew 2399: ("<script>document.statusform.status.value = ' $text'</script>\n");
1.148 matthew 2400: $r->rflush();
2401: }
2402:
1.214 matthew 2403: {
1.250 www 2404: my $max_time = 300; # seconds for the search to complete
1.214 matthew 2405: my $start_time = 0;
2406: my $last_time = 0;
2407:
2408: sub reset_timing {
2409: $start_time = 0;
2410: $last_time = 0;
2411: }
2412:
2413: sub time_left {
2414: if ($start_time == 0) {
2415: $start_time = time;
2416: }
2417: my $time_left = $max_time - (time - $start_time);
2418: $time_left = 0 if ($time_left < 0);
2419: return $time_left;
2420: }
2421:
1.150 matthew 2422: sub update_seconds {
1.214 matthew 2423: my ($r) = @_;
2424: my $time = &time_left();
2425: if (($last_time-$time) > 0) {
2426: $r->print("<script>".
2427: "document.statusform.seconds.value = '$time'".
2428: "</script>\n");
2429: $r->rflush();
2430: }
2431: $last_time = $time;
2432: }
2433:
1.148 matthew 2434: }
2435:
2436: ######################################################################
2437: ######################################################################
2438:
2439: =pod
2440:
1.204 matthew 2441: =item &revise_button()
1.151 matthew 2442:
2443: Inputs: None
2444:
2445: Returns: html string for a 'revise search' button.
2446:
2447: =cut
2448:
2449: ######################################################################
2450: ######################################################################
2451: sub revise_button {
1.289 bisitz 2452: my $revisetext = &mt('Revise search');
1.151 matthew 2453: my $revise_phase = 'disp_basic';
1.243 albertel 2454: $revise_phase = 'disp_adv' if ($env{'form.searchmode'} eq 'advanced');
1.151 matthew 2455: my $newloc = '/adm/searchcat'.
1.243 albertel 2456: '?persistent_db_id='.$env{'form.persistent_db_id'}.
1.309 bisitz 2457: '&cleargroupsort=1'.
2458: '&phase='.$revise_phase;
1.289 bisitz 2459: my $result = qq{<input type="button" value="$revisetext" name="revise"} .
1.151 matthew 2460: qq{ onClick="parent.location='$newloc';" /> };
2461: return $result;
2462: }
2463:
2464: ######################################################################
2465: ######################################################################
2466:
2467: =pod
2468:
1.204 matthew 2469: =item &run_search()
2470:
2471: Executes a search query by sending it the the other servers and putting the
2472: results into MySQL.
1.144 matthew 2473:
2474: =cut
2475:
2476: ######################################################################
2477: ######################################################################
2478: sub run_search {
1.276 raeburn 2479: my ($r,$query,$customquery,$customshow,$serverlist,
2480: $pretty_string,$area) = @_;
2481: my $tabletype = 'metadata';
2482: if ($area eq 'portfolio') {
2483: $tabletype = 'portfolio_search';
2484: }
1.150 matthew 2485: my $connection = $r->connection;
1.144 matthew 2486: #
1.146 matthew 2487: # Print run_search header
2488: #
1.307 bisitz 2489: my $start_page = &Apache::loncommon::start_page('Search Status',undef);
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: END
1.230 matthew 2497: # Remove leading and trailing <br />
2498: $pretty_string =~ s:^\s*<br />::i;
2499: $pretty_string =~ s:(<br />)*\s*$::im;
2500: my @Lines = split("<br />",$pretty_string);
2501: # I keep getting blank items at the end of the list, hence the following:
2502: while ($Lines[-1] =~ /^\s*$/ && @Lines) {
2503: pop(@Lines);
2504: }
1.152 matthew 2505: if (@Lines > 2) {
1.298 bisitz 2506: $pretty_string = join '<br />',(@Lines[0..2],'...<br />');
1.151 matthew 2507: }
1.214 matthew 2508: $r->print(&mt("Search: [_1]",$pretty_string));
1.146 matthew 2509: $r->rflush();
2510: #
1.145 matthew 2511: # Determine the servers we need to contact.
1.144 matthew 2512: my @Servers_to_contact;
2513: if (defined($serverlist)) {
1.152 matthew 2514: if (ref($serverlist) eq 'ARRAY') {
2515: @Servers_to_contact = @$serverlist;
2516: } else {
2517: @Servers_to_contact = ($serverlist);
2518: }
1.144 matthew 2519: } else {
1.281 albertel 2520: my %all_library_servers = &Apache::lonnet::all_library();
2521: @Servers_to_contact = sort(keys(%all_library_servers));
1.144 matthew 2522: }
2523: my %Server_status;
1.214 matthew 2524: #
2525: # Check on the mysql table we will use to store results.
1.243 albertel 2526: my $table =$env{'form.table'};
1.150 matthew 2527: if (! defined($table) || $table eq '' || $table =~ /\D/ ) {
1.286 albertel 2528: $r->print("Unable to determine table id to save search results in.".
1.256 albertel 2529: "The search has been aborted.".
2530: &Apache::loncommon::end_page());
1.147 matthew 2531: return;
2532: }
2533: my $table_status = &Apache::lonmysql::check_table($table);
2534: if (! defined($table_status)) {
1.256 albertel 2535: $r->print("Unable to determine status of table.".
2536: &Apache::loncommon::end_page());
1.147 matthew 2537: &Apache::lonnet::logthis("Bogus table id of $table for ".
1.243 albertel 2538: "$env{'user.name'} @ $env{'user.domain'}");
1.147 matthew 2539: &Apache::lonnet::logthis("lonmysql error = ".
1.144 matthew 2540: &Apache::lonmysql::get_error());
1.147 matthew 2541: return;
2542: }
2543: if (! $table_status) {
1.204 matthew 2544: &Apache::lonnet::logthis("lonmysql error = ".
2545: &Apache::lonmysql::get_error());
2546: &Apache::lonnet::logthis("lonmysql debug = ".
2547: &Apache::lonmysql::get_debug());
2548: &Apache::lonnet::logthis('table status = "'.$table_status.'"');
1.147 matthew 2549: $r->print("The table id,$table, we tried to use is invalid.".
1.256 albertel 2550: "The search has been aborted.".
2551: &Apache::loncommon::end_page());
1.144 matthew 2552: return;
2553: }
1.145 matthew 2554: ##
1.146 matthew 2555: ## Prepare for the big loop.
1.144 matthew 2556: my $hitcountsum;
1.276 raeburn 2557: my %matches;
1.144 matthew 2558: my $server;
2559: my $status;
1.151 matthew 2560: my $revise = &revise_button();
1.299 raeburn 2561: $r->print('<form name="statusform" action="" method="post">'."\n".
2562: '<input type="hidden" name="acts" value="" />'."\n".
2563: '<table border="0"><tr><td>'."\n".
2564: &Apache::loncommon::start_data_table());
1.298 bisitz 2565: $r->print(&Apache::loncommon::start_data_table_header_row()
2566: .'<th>'.&mt('Status').'</th>'
2567: .'<th>'.&mt('Total Matches').'</th>'
2568: .'<th>'.&mt('Time Remaining').'</th>'
1.299 raeburn 2569: .&Apache::loncommon::end_data_table_header_row()
2570: .&Apache::loncommon::start_data_table_row()
1.298 bisitz 2571: .'<td><input type="text" name="status" value="" size="50" readonly="readonly" /></td>'
2572: .'<td><input type="text" name="count" value="" size="10" readonly="readonly" /></td>'
2573: .'<td><input type="text" name="seconds" value="" size="8" readonly="readonly" /></td>'
1.299 raeburn 2574: .&Apache::loncommon::end_data_table_row()
2575: .&Apache::loncommon::end_data_table()
2576: .'</td><td> </td><td>'.$revise.'</td></tr></table></form>');
1.148 matthew 2577: $r->rflush();
1.214 matthew 2578: &reset_timing();
2579: &update_seconds($r);
2580: &update_status($r,&mt('contacting [_1]',$Servers_to_contact[0]));
2581: while (&time_left() &&
1.144 matthew 2582: ((@Servers_to_contact) || keys(%Server_status))) {
1.214 matthew 2583: &update_seconds($r);
2584: #
2585: # Send out a search request
1.144 matthew 2586: if (@Servers_to_contact) {
2587: # Contact one server
2588: my $server = shift(@Servers_to_contact);
1.214 matthew 2589: &update_status($r,&mt('contacting [_1]',$server));
1.144 matthew 2590: my $reply=&Apache::lonnet::metadata_query($query,$customquery,
2591: $customshow,[$server]);
2592: ($server) = keys(%$reply);
2593: $Server_status{$server} = $reply->{$server};
2594: } else {
1.150 matthew 2595: # wait a sec. to give time for files to be written
2596: # This sleep statement is here instead of outside the else
2597: # block because we do not want to pause if we have servers
2598: # left to contact.
1.183 matthew 2599: if (scalar (keys(%Server_status))) {
2600: &update_status($r,
1.214 matthew 2601: &mt('waiting on [_1]',join(' ',keys(%Server_status))));
1.183 matthew 2602: }
1.150 matthew 2603: sleep(1);
1.144 matthew 2604: }
1.159 matthew 2605: #
2606: # Loop through the servers we have contacted but do not
2607: # have results from yet, looking for results.
1.228 matthew 2608: foreach my $server (keys(%Server_status)) {
1.150 matthew 2609: last if ($connection->aborted());
1.214 matthew 2610: &update_seconds($r);
1.228 matthew 2611: my $status = $Server_status{$server};
1.144 matthew 2612: if ($status eq 'con_lost') {
2613: delete ($Server_status{$server});
2614: next;
2615: }
1.276 raeburn 2616: $status=~s|/||g;
1.242 albertel 2617: my $datafile=$r->dir_config('lonDaemons').'/tmp/'.$status;
1.144 matthew 2618: if (-e $datafile && ! -e "$datafile.end") {
1.214 matthew 2619: &update_status($r,&mt('Receiving results from [_1]',$server));
1.144 matthew 2620: next;
2621: }
1.150 matthew 2622: last if ($connection->aborted());
1.144 matthew 2623: if (-e "$datafile.end") {
1.214 matthew 2624: &update_status($r,&mt('Reading results from [_1]',$server));
1.144 matthew 2625: if (-z "$datafile") {
2626: delete($Server_status{$server});
2627: next;
2628: }
2629: my $fh;
2630: if (!($fh=Apache::File->new($datafile))) {
1.146 matthew 2631: $r->print("Unable to open search results file for ".
1.145 matthew 2632: "server $server. Omitting from search");
1.150 matthew 2633: delete($Server_status{$server});
2634: next;
1.144 matthew 2635: }
2636: # Read in the whole file.
2637: while (my $result = <$fh>) {
1.150 matthew 2638: last if ($connection->aborted());
1.214 matthew 2639: #
2640: # Records are stored one per line
1.144 matthew 2641: chomp($result);
1.214 matthew 2642: next if (! $result);
2643: #
1.144 matthew 2644: # Parse the result.
1.276 raeburn 2645: my %Fields = &parse_raw_result($result,$server,$tabletype);
1.144 matthew 2646: $Fields{'hostname'} = $server;
1.214 matthew 2647: #
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.301 bisitz 2901: '<span class="LC_nobreak">'.$sortform.'</span>'.
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.309 bisitz 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.309 bisitz 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.309 bisitz 3280: my $basic_link = "/adm/searchcat?"."&table=".$env{'form.table'}.
3281: "&persistent_db_id=".$env{'form.persistent_db_id'};
3282: my $results_link = $basic_link."&phase=results".
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.309 bisitz 3291: my $basic_link = "/adm/searchcat?"."&table=".$env{'form.table'}.
3292: "&persistent_db_id=".$env{'form.persistent_db_id'};
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: }
1.308 bisitz 3477: $result .= '<hr />'."\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.308 bisitz 3529: <hr />
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.306 bisitz 3562: $prefix.'<img src="'.&Apache::loncommon::icon($values{'url'}).'" alt="" />';
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'};
1.308 bisitz 3639: $result .= '<hr />'."\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.308 bisitz 3713: <hr />
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.309 bisitz 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.309 bisitz 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