loncom/interface/lonindexer.pm - view

File: [LON-CAPA] / loncom / interface / lonindexer.pm
Revision 1.42: download - view: text, annotated - select for diffs
Fri May 31 21:50:30 2002 UTC (22 years ago) by albertel
Branches: MAIN
CVS tags: HEAD

- lonindexer now deals with titles with HTML and " in them properly (BUG#487)
- Complex RAT needs to escape " before sending them out. (And currently uses &#34 rather than &quot)
- Simple Rat seems to work okay.

1: # The LearningOnline Network with CAPA 2: # Directory Indexer 3: # 4: # $Id: lonindexer.pm,v 1.42 2002/05/31 21:50:30 albertel Exp $ 5: # 6: # Copyright Michigan State University Board of Trustees 7: # 8: # This file is part of the LearningOnline Network with CAPA (LON-CAPA). 9: # 10: # LON-CAPA is free software; you can redistribute it and/or modify 11: # it under the terms of the GNU General Public License as published by 12: # the Free Software Foundation; either version 2 of the License, or 13: # (at your option) any later version. 14: # 15: # LON-CAPA is distributed in the hope that it will be useful, 16: # but WITHOUT ANY WARRANTY; without even the implied warranty of 17: # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 18: # GNU General Public License for more details. 19: # 20: # You should have received a copy of the GNU General Public License 21: # along with LON-CAPA; if not, write to the Free Software 22: # Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA 23: # 24: # /home/httpd/html/adm/gpl.txt 25: # 26: # http://www.lon-capa.org/ 27: # 28: # YEAR=1999 29: # 5/21/99, 5/22,5/25,5/26,5/31,6/2,6/10,7/12,7/14 Gerd Kortemeyer) 30: # 11/23 Gerd Kortemeyer 31: # YEAR=2000 32: # 07/20-08/04 H.K. Ng 33: # YEAR=2001 34: # 05/9-05/19/2001 H. K. Ng 35: # 05/21/2001 H. K. Ng 36: # 05/23/2001 H. K. Ng 37: # 5/31,6/1,6/2,6/15 Scott Harrison 38: # 6/26,7/8 H. K. Ng 39: # 8/6,8/7,8/10 Scott Harrison 40: # 8/14 H. K. Ng 41: # 8/28,10/15,11/28,11/29 Scott Harrison 42: # 11/30 Matthew Hall 43: # 12/11,12/13 Scott Harrison 44: # YEAR=2002 45: # 1/17 Scott Harrison 46: # 47: ### 48: 49: ############################################################################### 50: ## ## 51: ## ORGANIZATION OF THIS PERL MODULE ## 52: ## ## 53: ## 1. Description of functions ## 54: ## 2. Modules used by this module ## 55: ## 3. Choices for different output views (detailed, summary, xml, etc) ## 56: ## 4. BEGIN block (to be run once after compilation) ## 57: ## 5. Handling routine called via Apache and mod_perl ## 58: ## 6. Other subroutines ## 59: ## ## 60: ############################################################################### 61: 62: package Apache::lonindexer; 63: 64: # ------------------------------------------------- modules used by this module 65: use strict; 66: use Apache::lonnet(); 67: use Apache::loncommon(); 68: use Apache::Constants qw(:common); 69: use Apache::File; 70: use GDBM_File; 71: 72: # ---------------------------------------- variables used throughout the module 73: my %hash; # tied to a user-specific gdbm file 74: my %dirs; # keys are directories, values are the open/close status 75: my %language; # has the reference information present in language.tab 76: 77: # ----- Values which are set by the handler subroutine and are accessible to 78: # ----- other methods. 79: my $extrafield; # default extra table cell 80: my $fnum; # file counter 81: my $dnum; # directory counter 82: 83: # ----- Used to include or exclude files with certain extensions. 84: my @Only = (); 85: my @Omit = (); 86: 87: 88: # ----------------------------- Handling routine called via Apache and mod_perl 89: sub handler { 90: my $r = shift; 91: $r->content_type('text/html'); 92: $r->send_http_header; 93: return OK if $r->header_only; 94: $fnum=0; 95: $dnum=0; 96: untie %hash; 97: 98: # ------------------------------------- read in machine configuration variables 99: my $iconpath= $r->dir_config('lonIconsURL') . "/"; 100: my $domain = $r->dir_config('lonDefDomain'); 101: my $role = $r->dir_config('lonRole'); 102: my $loadlim = $r->dir_config('lonLoadLim'); 103: my $servadm = $r->dir_config('lonAdmEMail'); 104: my $sysadm = $r->dir_config('lonSysEMail'); 105: my $lonhost = $r->dir_config('lonHostID'); 106: my $tabdir = $r->dir_config('lonTabDir'); 107: 108: my $fileclr='#ffffe6'; 109: my $line; 110: my (@attrchk,@openpath); 111: my $uri=$r->uri; 112: 113: # -------------------------------------- see if called from an interactive mode 114: # Get the parameters from the query string 115: &Apache::loncommon::get_unprocessed_cgi($ENV{'QUERY_STRING'}, 116: ['catalogmode','launch','acts','mode','form','element', 117: 'only','omit']); 118: #------------------------------------------------------------------- 119: my $closebutton=''; 120: my $groupimportbutton=''; 121: my $colspan=''; 122: 123: $extrafield=''; 124: my $diropendb = 125: "/home/httpd/perl/tmp/$domain\_$ENV{'user.name'}_indexer.db"; 126: 127: if (tie(%hash,'GDBM_File',$diropendb,&GDBM_WRCREAT,0640)) { 128: if ($ENV{'form.launch'} eq '1') { 129: &start_fresh_session(); 130: } 131: 132: # -------------------- refresh environment with user database values (in %hash) 133: if ($hash{'mode_catalog'} eq 'interactive') { 134: $ENV{'form.catalogmode'}='interactive'; 135: } 136: if ($hash{'mode_catalog'} eq 'groupimport') { 137: $ENV{'form.catalogmode'}='groupimport'; 138: } 139: 140: # --------------------- define extra fields and buttons in case of special mode 141: if ($ENV{'form.catalogmode'} eq 'interactive') { 142: $hash{'mode_catalog'}='interactive'; 143: $extrafield='<td bgcolor="'.$fileclr.'" valign="bottom">'. 144: '<a name="$anchor"><img src="'.$iconpath.'whitespace1.gif"'. 145: ' border="0" /></td>'; 146: $colspan=" colspan='2' "; 147: $closebutton=<<END; 148: <input type="button" name="close" value='CLOSE' onClick="self.close()"> 149: END 150: } 151: elsif ($ENV{'form.catalogmode'} eq 'groupimport') { 152: $hash{'mode_catalog'}='groupimport'; 153: $extrafield='<td bgcolor="'.$fileclr.'" valign="bottom">'. 154: '<a name="$anchor"><img src="'.$iconpath.'whitespace1.gif"'. 155: ' border="0" /></td>'; 156: $colspan=" colspan='2' "; 157: $closebutton=<<END; 158: <input type="button" name="close" value='CLOSE' onClick="self.close()"> 159: END 160: $groupimportbutton=<<END; 161: <input type="button" name="groupimport" value='GROUP IMPORT' 162: onClick="javascript:select_group()"> 163: END 164: } 165: # Additions made by Matthew to make the browser a little easier to deal 166: # with in the future. 167: # 168: # $mode (at this time) indicates if we are in edit mode. 169: # $form is the name of the form that the URL is placed when the 170: # selection is made. 171: # $element is the name of the element in $formname which receives 172: # the URL. 173: # &Apache::lonxml::debug('Checking mode, form, element'); 174: &setvalues(\%hash,'form_mode' ,\%ENV,'form.mode' ); 175: &setvalues(\%hash,'form_form' ,\%ENV,'form.form' ); 176: &setvalues(\%hash,'form_element',\%ENV,'form.element'); 177: &setvalues(\%hash,'form_only' ,\%ENV,'form.only' ); 178: &setvalues(\%hash,'form_omit' ,\%ENV,'form.omit' ); 179: 180: # Deal with 'omit' and 'only' 181: if (exists $ENV{'form.omit'}) { 182: @Omit = split(',',$ENV{'form.omit'}); 183: } 184: if (exists $ENV{'form.only'}) { 185: @Only = split(',',$ENV{'form.only'}); 186: } 187: 188: my $mode = $ENV{'form.mode'}; 189: my ($form,$element); 190: if ($mode eq 'edit' || $mode eq 'parmset') { 191: $form = $ENV{'form.form'}; 192: $element = $ENV{'form.element'}; 193: } 194: &Apache::lonxml::debug("mode=$mode form=$form element=$element"); 195: # ------ set catalogmodefunctions to have extra needed javascript functionality 196: my $catalogmodefunctions=''; 197: if ($ENV{'form.catalogmode'} eq 'interactive' or 198: $ENV{'form.catalogmode'} eq 'groupimport') { 199: # The if statement below sets us up to use the old version 200: # by default (ie. if $mode is undefined). This is the easy 201: # way out. Hopefully in the future I'll find a way to get 202: # the calls dealt with in a more comprehensive manner. 203: 204: # 205: # There is now also mode "simple", which is for the simple version of the rat 206: # 207: # 208: if (!defined($mode) || ($mode ne 'edit' && $mode ne 'parmset')) { 209: my $location = "/adm/groupsort?catalogmode=groupimport&"; 210: $location .= "mode=".$mode."&"; 211: $location .= "acts="; 212: $catalogmodefunctions=<<"END"; 213: function select_data(title,url) { 214: changeTitle(title); 215: changeURL(url); 216: self.close(); 217: } 218: function select_group() { 219: window.location="$location"+document.forms.fileattr.acts.value; 220: } 221: function changeTitle(val) { 222: if (opener.inf) { 223: if (opener.inf.document.forms.resinfo.elements.t) { 224: opener.inf.document.forms.resinfo.elements.t.value=val; 225: } 226: } 227: } 228: function changeURL(val) { 229: if (opener.inf) { 230: if (opener.inf.document.forms.resinfo.elements.u) { 231: opener.inf.document.forms.resinfo.elements.u.value=val; 232: } 233: } 234: } 235: END 236: } elsif ($mode eq 'edit') { # we are in 'edit' mode 237: my $location = "/adm/groupsort?catalogmode=interactive&"; 238: $location .= "form=$form&element=$element&mode=edit&acts="; 239: $catalogmodefunctions=<<END; 240: // mode = $mode 241: function select_data(title,url) { 242: changeURL(url); 243: self.close(); 244: } 245: 246: function select_group() { 247: window.location="$location"+document.forms.fileattr.acts.value; 248: } 249: 250: function changeURL(val) { 251: if (window.opener.document) { 252: window.opener.document.forms["$form"].elements["$element"].value=val; 253: } else { 254: alert("The file you selected is: "+val); 255: } 256: } 257: 258: END 259: } elsif ($mode eq 'parmset') { 260: my $location = "/adm/groupsort?catalogmode=interactive&"; 261: $location .= "form=$form&element=$element&mode=parmset&acts="; 262: $catalogmodefunctions=<<END; 263: // mode = $mode 264: function select_data(title,url) { 265: changeURL(url); 266: self.close(); 267: } 268: 269: function select_group() { 270: window.location="$location"+document.forms.fileattr.acts.value; 271: } 272: 273: function changeURL(val) { 274: if (window.opener.document) { 275: var elementname = "$element"+"_value"; 276: var checkboxname = "$element"+"_setparmval"; 277: window.opener.document.forms["$form"].elements[elementname].value=val; 278: window.opener.document.forms["$form"].elements[checkboxname].checked=true; 279: } else { 280: alert("The file you selected is: "+val); 281: } 282: } 283: 284: END 285: } 286: } 287: $catalogmodefunctions.=<<END; 288: var acts=''; 289: function rep_dirpath(suffix,val) { 290: eval("document.forms.dirpath"+suffix+".acts.value=val"); 291: } 292: END 293: if ($ENV{'form.catalogmode'} eq 'groupimport') { 294: $catalogmodefunctions.=<<END; 295: function queue(val) { 296: if (eval("document.forms."+val+".filelink.checked")) { 297: var l=val.length; 298: var v=val.substring(4,l); 299: document.forms.fileattr.acts.value+='1a'+v+'b'; 300: } 301: else { 302: var l=val.length; 303: var v=val.substring(4,l); 304: document.forms.fileattr.acts.value+='0a'+v+'b'; 305: } 306: } 307: END 308: } 309: 310: # ---------------------------------------------------------------- Print Header 311: $r->print(<<ENDHEADER); 312: <html> 313: <head> 314: <title>The LearningOnline Network With CAPA Directory Browser</title> 315: 316: <script type="text/javascript"> 317: $catalogmodefunctions 318: function openWindow(url, wdwName, w, h, toolbar,scrollbar) { 319: var options = "width=" + w + ",height=" + h + ","; 320: options += "resizable=yes,scrollbars="+scrollbar+",status=no,"; 321: options += "menubar=no,toolbar="+toolbar+",location=no,directories=no"; 322: var newWin = window.open(url, wdwName, options); 323: newWin.focus(); 324: } 325: function gothere(val) { 326: window.location=val+'?acts='+document.forms.fileattr.acts.value; 327: } 328: </script> 329: 330: </head> 331: <body bgcolor="#FFFFFF"> 332: ENDHEADER 333: 334: # - Evaluate actions from previous page (both cumulatively and chronologically) 335: if ($ENV{'form.catalogmode'} eq 'groupimport') { 336: my $acts=$ENV{'form.acts'}; 337: my @Acts=split(/b/,$acts); 338: my %ahash; 339: my %achash; 340: my $ac=0; 341: # some initial hashes for working with data 342: foreach (@Acts) { 343: my ($state,$ref)=split(/a/); 344: $ahash{$ref}=$state; 345: $achash{$ref}=$ac; 346: $ac++; 347: } 348: # sorting through the actions and changing the tied database hash 349: foreach (sort {$achash{$a}<=>$achash{$b}} (keys %ahash)) { 350: my $key=$_; 351: if ($ahash{$key} eq '1') { 352: $hash{'store_'.$hash{'pre_'.$key.'_link'}}= 353: $hash{'pre_'.$key.'_title'}; 354: $hash{'storectr_'.$hash{'pre_'.$key.'_link'}}= 355: $hash{'storectr'}+0; 356: $hash{'storectr'}++; 357: } 358: if ($ahash{$key} eq '0') { 359: if ($hash{'store_'.$hash{'pre_'.$key.'_link'}}) { 360: delete $hash{'store_'.$hash{'pre_'.$key.'_link'}}; 361: } 362: } 363: } 364: # deleting the previously cached listing 365: foreach (keys %hash) { 366: if ($_ =~ /^pre_/ && $_ =~/link$/) { 367: my $key = $_; 368: $key =~ s/^pre_//; 369: $key =~ s/_[^_]*$//; 370: delete $hash{'pre_'.$key.'_title'}; 371: delete $hash{'pre_'.$key.'_link'}; 372: } 373: } 374: } 375: 376: # ---------------------------------------------------------------- output title 377: $r->print( 378: '<h2><font color="#888888">The Learning<i>Online</i> Network with CAPA '. 379: 'Network Directory Browser</font></h2>'."\n"); 380: # ---------------------------------- get state of file attributes to be showing 381: if ($ENV{'form.attrs'} ne "") { 382: for (my $i=0; $i<=6; $i++) { 383: delete $hash{'display_attrs_'.$i}; 384: if ($ENV{'form.attr'.$i} == 1) { 385: $attrchk[$i] = "checked"; 386: $hash{'display_attrs_'.$i} = 1; 387: } 388: } 389: } else { 390: for (my $i=0; $i<=6; $i++) { 391: $attrchk[$i] = "checked" if $hash{'display_attrs_'.$i} == 1; 392: } 393: } 394: # ------------------------------- output state of file attributes to be showing 395: $r->print(<<END); 396: <b><font color="#666666">Display file attributes</font></b><br /> 397: <form method="post" name="fileattr" action="$uri" 398: enctype="application/x-www-form-urlencoded"> 399: <table border=0><tr> 400: <td><input type="checkbox" name="attr0" value="1" $attrchk[0] /> Size</td> 401: <td><input type="checkbox" name="attr1" value="1" $attrchk[1] /> Last access</td> 402: <td><input type="checkbox" name="attr2" value="1" $attrchk[2] /> Last modified</td> 403: <td><input type="checkbox" name="attr6" value="1" $attrchk[6] /> All versions</td> 404: </tr><tr> 405: <td><input type="checkbox" name="attr3" value="1" $attrchk[3] /> Author</td> 406: <td><input type="checkbox" name="attr4" value="1" $attrchk[4] /> Keywords</td> 407: <td><input type="checkbox" name="attr5" value="1" $attrchk[5] /> Language</td> 408: <td> </td> 409: </tr></table> 410: <input type="hidden" name="dirPointer" value="on" /> 411: <input type="hidden" name="acts" value="" /> 412: <input type="submit" name="attrs" value="Review" />  413: <input type="submit" name="attrs" value="Refresh" /> 414: $closebutton 415: $groupimportbutton 416: </form> 417: END 418: 419: # ----------------- output starting row to the indexed file/directory hierarchy 420: my $titleclr="#ddffff"; 421: # $r->print(&initdebug()); 422: # $r->print(&writedebug("Omit:@Omit")) if (@Omit); 423: # $r->print(&writedebug("Only:@Only")) if (@Only); 424: $r->print("<table width='100\%' border=0><tr><td bgcolor=#eeeeee>\n"); 425: $r->print("<table width='100\%' border=0><tr>\n"); 426: $r->print("<td $colspan bgcolor=$titleclr><b>Name</b></td>\n"); 427: $r->print("<td bgcolor=$titleclr align=right><b>Size (bytes) ". 428: "</b></td>\n") if ($hash{'display_attrs_0'} == 1); 429: $r->print("<td bgcolor=$titleclr><b>Last accessed</b></td>\n") 430: if ($hash{'display_attrs_1'} == 1); 431: $r->print("<td bgcolor=$titleclr><b>Last modified</b></td>\n") 432: if ($hash{'display_attrs_2'} == 1); 433: $r->print("<td bgcolor=$titleclr><b>Author(s)</b></td>\n") 434: if ($hash{'display_attrs_3'} == 1); 435: $r->print("<td bgcolor=$titleclr><b>Keywords</b></td>\n") 436: if ($hash{'display_attrs_4'} == 1); 437: $r->print("<td bgcolor=$titleclr><b>Language</b></td>\n") 438: if ($hash{'display_attrs_5'} == 1); 439: $r->print("</tr>"); 440: 441: # ----------------- read in what directories have previously been set to "open" 442: foreach (keys %hash) { 443: if ($_ =~ /^diropen_status_/) { 444: my $key = $_; 445: $key =~ s/^diropen_status_//; 446: $dirs{$key} = $hash{$_}; 447: } 448: } 449: 450: if ($ENV{'form.openuri'}) { # take care of review and refresh options 451: my $uri=$ENV{'form.openuri'}; 452: if (exists($hash{'diropen_status_'.$uri})) { 453: my $cursta = $hash{'diropen_status_'.$uri}; 454: $dirs{$uri} = 'open'; 455: $hash{'diropen_status_'.$uri} = 'open'; 456: if ($cursta eq 'open') { 457: $dirs{$uri} = 'closed'; 458: $hash{'diropen_status_'.$uri} = 'closed'; 459: } 460: } else { 461: $hash{'diropen_status_'.$uri} = 'open'; 462: $dirs{$uri} = 'open'; 463: } 464: } 465: 466: my $bredir = $ENV{'form.dirPointer'}; 467: my $toplevel; 468: my $indent = 0; 469: $uri = $uri.'/' if $uri !~ /.*\/$/; 470: 471: if ($bredir ne "on") { 472: $hash{'top.level'} = $uri; 473: $toplevel = $uri; 474: 475: } else { 476: $toplevel = $hash{'top.level'}; 477: } 478: 479: # -------------------------------- if not at top level, provide an uplink arrow 480: if ($toplevel ne "/res/"){ 481: my (@uri_com) = split(/\//,$uri); 482: pop @uri_com; 483: my $upone = join('/',@uri_com); 484: my @list = qw (0); 485: &display_line ($r,'opened',$upone.'&viewOneUp',0,$upone,@list); 486: $indent = 1; 487: } 488: 489: # -------- recursively go through all the directories and output as appropriate 490: &scanDir ($r,$toplevel,$indent,\%hash); 491: 492: # ---------------------------- embed hidden information useful for group import 493: $r->print("<form name='fnum'>"); 494: $r->print("<input type='hidden' name='fnum' value='$fnum'></form>"); 495: 496: # -------------------------------------------------------------- end the tables 497: $r->print("</table>"); 498: $r->print("</td></tr></table>"); 499: 500: # --------------------------------------------------- end the output and return 501: $r->print("</body></html>\n"); 502: untie(%hash); 503: } else { 504: $r->print('<html><head></head><body>Unable to tie hash to db '. 505: 'file</body></html>'); 506: return OK; 507: } 508: return OK; 509: } 510: 511: # ----------------------------------------------- recursive scan of a directory 512: sub scanDir { 513: my ($r,$startdir,$indent,$hashref)=@_; 514: my ($compuri,$curdir); 515: my $dirptr=16384; 516: $indent++; 517: 518: my %dupdirs = %dirs; 519: my @list=&get_list($r,$startdir); 520: foreach my $line (@list) { 521: my ($strip,$dom,$foo,$testdir,$foo)=split(/\&/,$line,5); 522: next if $strip =~ /.*\.meta$/; 523: my (@fileparts) = split(/\./,$strip); 524: if ($hash{'display_attrs_6'} != 1) { 525: if (scalar(@fileparts) >= 3) { 526: my $fext = pop @fileparts; 527: my $ov = pop @fileparts; 528: my $fname = join ('.',@fileparts,$fext); 529: next if (grep /$fname/,@list and $ov =~ /\d+/); 530: } 531: } 532: 533: if ($dom eq "domain") { 534: $compuri = join('',$strip,"/"); # dom list has /res/<domain name> 535: $curdir = $compuri; 536: } else { 537: # user, dir & file have name only, i.e., w/o path 538: $compuri = join('',$startdir,$strip,"/"); 539: $curdir = $startdir; 540: } 541: my $diropen = "closed"; 542: if (($dirptr&$testdir) or ($dom =~ /^(domain|user)$/)) { 543: while (my ($key,$val)= each %dupdirs) { 544: if ($key eq $compuri and $val eq "open") { 545: $diropen = "opened"; 546: delete $dupdirs{key},$dirs{$key}; 547: } 548: } 549: } 550: &display_line($r,$diropen,$line,$indent,$curdir,$hashref,@list); 551: &scanDir ($r,$compuri,$indent) if $diropen eq "opened"; 552: } 553: $indent--; 554: } 555: 556: # --------------- get complete matched list based on the uri (returns an array) 557: sub get_list { 558: my ($r,$uri)=@_; 559: my @list; 560: my $luri = $uri; 561: $luri =~ s/\//_/g; 562: 563: if ($ENV{'form.attrs'} eq "Refresh") { 564: foreach (keys %hash) { 565: delete $hash{$_} if ($_ =~ /^dirlist_files_/); 566: } 567: } 568: 569: if ($hash{'dirlist_files'.$luri}) { 570: @list = split(/\n/,$hash{'dirlist_files_'.$luri}); 571: } else { 572: @list = &Apache::lonnet::dirlist($uri); 573: $hash{'dirlist_files_'.$luri} = join('\n',@list); 574: } 575: return @list=&match_ext($r,@list); 576: } 577: 578: sub initdebug { 579: return <<ENDJS; 580: <script> 581: var debugging = true; 582: if (debugging) { 583: var debuggingWindow = window.open('','Debug','width=400,height=300',true); 584: } 585: 586: function output(text) { 587: if (debugging) { 588: debuggingWindow.document.writeln(text); 589: } 590: } 591: output("<html><head><title>Debugging Window</title></head><body><pre>"); 592: </script> 593: ENDJS 594: } 595: 596: sub writedebug { 597: my $text = shift; 598: return "<script>output('$text');</script>"; 599: } 600: 601: # -------------------- filters out files based on extensions (returns an array) 602: sub match_ext { 603: my ($r,@packlist)=@_; 604: my @trimlist; 605: my $nextline; 606: my @fileext; 607: my $dirptr=16384; 608: 609: foreach my $line (@packlist) { 610: chomp $line; 611: $line =~ s/^\/home\/httpd\/html//; 612: my @unpackline = split (/\&/,$line); 613: next if ($unpackline[0] eq "."); 614: next if ($unpackline[0] eq ".."); 615: my @filecom = split (/\./,$unpackline[0]); 616: my $fext = pop(@filecom); 617: my $fnptr = $unpackline[3]&$dirptr; 618: if ($fnptr == 0 and $unpackline[3] ne "") { 619: my $embstyle = &Apache::loncommon::fileembstyle($fext); 620: push @trimlist,$line if (defined($embstyle) && 621: ($embstyle ne 'hdn' or $fext eq 'meta')); 622: } else { 623: push @trimlist,$line; 624: } 625: } 626: @trimlist = sort (@trimlist); 627: return @trimlist; 628: } 629: 630: # ------------------------------- displays one line in appropriate table format 631: sub display_line { 632: my ($r,$diropen,$line,$indent,$startdir,$hashref,@list)=@_; 633: my (@pathfn, $fndir, $fnptr); 634: my $dirptr=16384; 635: my $fileclr="#ffffe6"; 636: my $iconpath= $r->dir_config('lonIconsURL') . "/"; 637: 638: my @filecom = split (/\&/,$line); 639: my @pathcom = split (/\//,$filecom[0]); 640: my $listname = $pathcom[scalar(@pathcom)-1]; 641: my $fnptr = $filecom[3]&$dirptr; 642: my $msg = 'View '.$filecom[0].' resources'; 643: $msg = 'Close '.$filecom[0].' directory' if $diropen eq "opened"; 644: 645: my $tabtag="</td>"; 646: my $i=0; 647: 648: while ($i<=5) { 649: $tabtag=join('',$tabtag,"<td bgcolor=",$fileclr,"> </td>") 650: if $hash{'display_attrs_'.$i} == 1; 651: $i++; 652: } 653: 654: # display uplink arrow 655: if ($filecom[1] eq "viewOneUp") { 656: $r->print("<tr>$extrafield"); 657: $r->print("<td bgcolor=$fileclr valign=bottom>\n"); 658: $r->print ('<form method="post" name="dirpathUP" action="'.$startdir. 659: '/" '. 660: 'onSubmit="return rep_dirpath(\'UP\','. 661: 'document.forms.fileattr.acts.value)" '. 662: 'enctype="application/x-www-form-urlencoded"'. 663: '>'."\n"); 664: $r->print ('<input type=hidden name=openuri value="'. 665: $startdir.'">'."\n"); 666: $r->print ('<input type="hidden" name="acts" value="">'."\n"); 667: $r->print ('<input src="'.$iconpath.'arrow_up.gif"'); 668: $r->print (' name="'.$msg.'" height="22" type="image" border="0">'. 669: "\n"); 670: $r->print("Up $tabtag</tr></form>\n"); 671: return OK; 672: } 673: 674: # display domain 675: if ($filecom[1] eq "domain") { 676: $r->print ('<input type="hidden" name="dirPointer" value="on">'."\n") 677: if ($ENV{'form.dirPointer'} eq "on"); 678: $r->print("<tr>$extrafield"); 679: $r->print("<td bgcolor=$fileclr valign=bottom>"); 680: &begin_form ($r,$filecom[0].'/'); 681: my $anchor = $filecom[0].'/'; 682: $anchor =~ s/\///g; 683: $r->print ('<a name="'.$anchor.'">'); 684: $r->print ('<input type="hidden" name="acts" value="">'); 685: $r->print ('<input src="'.$iconpath.'folder_pointer_'. 686: $diropen.'.gif"'); 687: $r->print (' name="'.$msg.'" height="22" type="image" border="0">'. 688: "\n"); 689: $r->print ('<a href="javascript:gothere(\''.$filecom[0]. 690: '/\')"><img src="'.$iconpath.'server.gif"'); 691: $r->print (' border="0" /></a>'."\n"); 692: $r->print("Domain - $listname $tabtag</tr></form>\n"); 693: return OK; 694: 695: # display user directory 696: } 697: if ($filecom[1] eq "user") { 698: $r->print("<tr>$extrafield"); 699: $r->print("<td bgcolor=$fileclr valign=bottom nowrap>\n"); 700: my $curdir = $startdir.$filecom[0].'/'; 701: my $anchor = $curdir; 702: $anchor =~ s/\///g; 703: &begin_form ($r,$curdir); 704: $r->print ('<a name="'.$anchor.'"><img src="'.$iconpath. 705: 'whitespace1.gif" border="0" />'."\n"); 706: $r->print ('<input type="hidden" name="acts" value="">'); 707: $r->print ('<input src="'.$iconpath.'folder_pointer_'.$diropen. 708: '.gif"'); 709: $r->print (' name="'.$msg.'" height="22" type="image" border="0">'. 710: "\n"); 711: $r->print ('<a href="javascript:gothere(\''.$curdir.'\')"><img src='. 712: $iconpath.'quill.gif border="0" name="'.$msg. 713: '" height="22" /></a>'); 714: $r->print ($listname.$tabtag.'</tr></form>'."\n"); 715: return OK; 716: } 717: 718: # display file 719: if ($fnptr == 0 and $filecom[3] ne "") { 720: my @file_ext = split (/\./,$listname); 721: my $curfext = $file_ext[-1]; 722: if (@Omit) { 723: foreach (@Omit) { return OK if ($curfext eq $_); } 724: } 725: if (@Only) { 726: my $skip = 1; 727: foreach (@Only) { $skip = 0 if ($curfext eq $_); } 728: return OK if ($skip > 0); 729: } 730: # Set the icon for the file 731: my $iconname = "unknown.gif"; 732: my $embstyle = &Apache::loncommon::fileembstyle($curfext); 733: # The unless conditional that follows is a bit of overkill 734: $iconname = $curfext.".gif" unless 735: (!defined($embstyle) || $embstyle eq 'unk' || $embstyle eq 'hdn'); 736: # 737: my $filelink = $startdir.$filecom[0]; 738: $r->print("<tr><td nowrap valign='bottom' bgcolor=$fileclr>"); 739: my $metafile = grep /^$filecom[0]\.meta\&/, @list; 740: my $title; 741: if ($ENV{'form.catalogmode'} eq 'interactive') { 742: $title=$listname; 743: $title = &Apache::lonnet::metadata($filelink,'title') 744: if ($metafile == 1); 745: $title=$listname unless $title; 746: my $titleesc=HTML::Entities::encode($title); 747: $titleesc=~s/\'/\\'/; #' (clean up this spare quote) 748: $r->print("<a href=\"javascript:select_data(\'", 749: $titleesc,"','",$filelink,"')\">"); 750: $r->print("<img src='",$iconpath,"select.gif' border='0' /></a>". 751: "\n"); 752: $r->print("</td><td valign='bottom' nowrap bgcolor=$fileclr>"); 753: } 754: elsif ($ENV{'form.catalogmode'} eq 'groupimport') { 755: $title=$listname; 756: $title = &Apache::lonnet::metadata($filelink,'title') 757: if ($metafile == 1); 758: $title=$listname unless $title; 759: my $titleesc=&HTML::Entities::encode($title); 760: $r->print("<form name='form$fnum'>\n"); 761: $r->print("<input type='checkbox' name='filelink"."' ". 762: "value='$filelink' onClick='". 763: "javascript:queue(\"form$fnum\")' "); 764: if ($hash{'store_'.$filelink}) { 765: $r->print("checked"); 766: } 767: $r->print(">\n"); 768: $r->print("<input type='hidden' name='title"."' ". 769: "value='$titleesc'>\n"); 770: $r->print("</form>\n"); 771: $r->print("</td><td valign='bottom' nowrap bgcolor=$fileclr>"); 772: $hash{"pre_${fnum}_link"}=$filelink; 773: $hash{"pre_${fnum}_title"}=$titleesc; 774: $fnum++; 775: } 776: 777: if ($indent > 0 and $indent < 11) { 778: $r->print("<img src=",$iconpath,"whitespace",$indent, 779: ".gif border='0' />\n"); 780: } elsif ($indent >0) { 781: my $ten = int($indent/10.); 782: my $rem = $indent%10.0; 783: my $count = 0; 784: while ($count < $ten) { 785: $r->print("<img src=",$iconpath, 786: "whitespace10.gif border='0' />\n"); 787: $count++; 788: } 789: $r->print("<img src=",$iconpath,"whitespace",$rem, 790: ".gif border='0' />\n") if $rem > 0; 791: } 792: 793: $r->print("<img src=$iconpath$iconname border='0' />\n"); 794: $r->print (" <a href=\"javascript:openWindow('".$filelink. 795: "', 'metadatafile', '450', '500', 'no', 'yes')\";". 796: " TARGET=_self>$listname</a> "); 797: 798: $r->print (" (<a href=\"javascript:openWindow('".$filelink. 799: ".meta', 'metadatafile', '400', '450', 'no', 'yes')\"; ". 800: "TARGET=_self>metadata</a>) ") if ($metafile == 1); 801: 802: $r->print("</td>\n"); 803: $r->print("<td bgcolor=$fileclr align=right valign=bottom> ", 804: $filecom[8]," </td>\n") 805: if $hash{'display_attrs_0'} == 1; 806: $r->print("<td bgcolor=$fileclr valign=bottom> ". 807: (localtime($filecom[9]))." </td>\n") 808: if $hash{'display_attrs_1'} == 1; 809: $r->print("<td bgcolor=$fileclr valign=bottom> ". 810: (localtime($filecom[10]))." </td>\n") 811: if $hash{'display_attrs_2'} == 1; 812: 813: if ($hash{'display_attrs_3'} == 1) { 814: my $author = &Apache::lonnet::metadata($filelink,'author') 815: if ($metafile == 1); 816: $author = ' ' if (!$author); 817: $r->print("<td bgcolor=$fileclr valign=bottom> ".$author. 818: " </td>\n"); 819: } 820: if ($hash{'display_attrs_4'} == 1) { 821: my $keywords = &Apache::lonnet::metadata($filelink,'keywords') 822: if ($metafile == 1); 823: $keywords = ' ' if (!$keywords); 824: $r->print("<td bgcolor=$fileclr valign=bottom> ".$keywords. 825: " </td>\n"); 826: } 827: if ($hash{'display_attrs_5'} == 1) { 828: my $lang = &Apache::lonnet::metadata($filelink,'language') 829: if ($metafile == 1); 830: $lang = &Apache::loncommon::languagedescription($lang); 831: $lang = ' ' if (!$lang); 832: $r->print("<td bgcolor=$fileclr valign=bottom> ".$lang. 833: " </td>\n"); 834: } 835: $r->print("</tr>\n"); 836: } 837: 838: # -- display directory 839: if ($fnptr == $dirptr) { 840: my @file_ext = split (/\./,$listname); 841: my $curfext = $file_ext[scalar(@file_ext)-1]; 842: my $curdir = $startdir.$filecom[0].'/'; 843: my $anchor = $curdir; 844: $anchor =~ s/\///g; 845: $r->print("<tr>$extrafield<td bgcolor=$fileclr valign=bottom>"); 846: &begin_form ($r,$curdir); 847: my $indentm1 = $indent-1; 848: if ($indentm1 < 11 and $indentm1 > 0) { 849: $r->print("<img src=",$iconpath,"whitespace",$indentm1, 850: ".gif border='0' />\n"); 851: } else { 852: my $ten = int($indentm1/10.); 853: my $rem = $indentm1%10.0; 854: my $count = 0; 855: while ($count < $ten) { 856: $r->print ("<img src=",$iconpath 857: ,"whitespace10.gif border='0' />\n"); 858: $count++; 859: } 860: $r->print ("<img src=",$iconpath,"whitespace",$rem, 861: ".gif border='0' />\n") if $rem > 0; 862: } 863: $r->print ('<input type="hidden" name="acts" value="">'); 864: $r->print ('<a name="'.$anchor.'"><input src="'.$iconpath. 865: 'folder_pointer_'.$diropen.'.gif"'); 866: $r->print (' name="'.$msg.'" height="22" type="image" border="0">'. 867: "\n"); 868: $r->print ('<a href="javascript:gothere(\''.$curdir.'\')"><img src="'. 869: $iconpath.'folder_'.$diropen.'.gif" border="0" /></a>'. 870: "\n"); 871: $r->print ("$listname$tabtag</tr></form>\n"); 872: } 873: 874: } 875: 876: # ------------------- prints the beginning of a form for directory or file link 877: sub begin_form { 878: my ($r,$uri) = @_; 879: my $anchor = $uri; 880: $anchor =~ s/\///g; 881: $r->print ('<form method="post" name="dirpath'.$dnum.'" action="'.$uri. 882: '#'.$anchor. 883: '" onSubmit="return rep_dirpath(\''.$dnum.'\''. 884: ',document.forms.fileattr.acts.value)" '. 885: 'enctype="application/x-www-form-urlencoded">'."\n"); 886: $r->print ('<input type="hidden" name="openuri" value="'.$uri.'">'. 887: "\n"); 888: $r->print ('<input type="hidden" name="dirPointer" value="on">'."\n"); 889: $dnum++; 890: } 891: 892: # --------- settings whenever the user causes the indexer window to be launched 893: sub start_fresh_session { 894: delete $hash{'mode_catalog'}; 895: delete $hash{'form_mode'}; 896: delete $hash{'form_form'}; 897: delete $hash{'form_element'}; 898: delete $hash{'form_omit'}; 899: delete $hash{'form_only'}; 900: foreach (keys %hash) { 901: if ($_ =~ /^pre_/) { 902: delete $hash{$_}; 903: } 904: if ($_ =~ /^store/) { 905: delete $hash{$_}; 906: } 907: } 908: } 909: 910: # ------------------------------------------------------------------- setvalues 911: sub setvalues { 912: # setvalues is used in registerurl to synchronize the database 913: # hash and environment hashes 914: my ($H1,$h1key,$H2,$h2key) =@_; 915: # 916: if (exists $H2->{$h2key}) { 917: $H1->{$h1key} = $H2->{$h2key}; 918: } elsif (exists $H1->{$h1key}) { 919: $H2->{$h2key} = $H1->{$h1key}; 920: } 921: } 922: 923: 1; 924: 925: =head1 NAME 926: 927: Apache::lonindexer - mod_perl module for cross server filesystem browsing 928: 929: =head1 SYNOPSIS 930: 931: Invoked by /etc/httpd/conf/srm.conf: 932: 933: <LocationMatch "^/res.*/$"> 934: SetHandler perl-script 935: PerlHandler Apache::lonindexer 936: </LocationMatch> 937: 938: =head1 INTRODUCTION 939: 940: This module enables a scheme of browsing across a cross server. 941: 942: This is part of the LearningOnline Network with CAPA project 943: described at http://www.lon-capa.org. 944: 945: =head1 BEGIN SUBROUTINE 946: 947: This routine is only run once after compilation. 948: 949: =over 4 950: 951: =item * 952: 953: Initializes %language hash table. 954: 955: =back 956: 957: =head1 HANDLER SUBROUTINE 958: 959: This routine is called by Apache and mod_perl. 960: 961: =over 4 962: 963: =item * 964: 965: read in machine configuration variables 966: 967: =item * 968: 969: see if called from an interactive mode 970: 971: =item * 972: 973: refresh environment with user database values (in %hash) 974: 975: =item * 976: 977: define extra fields and buttons in case of special mode 978: 979: =item * 980: 981: set catalogmodefunctions to have extra needed javascript functionality 982: 983: =item * 984: 985: print header 986: 987: =item * 988: 989: evaluate actions from previous page (both cumulatively and chronologically) 990: 991: =item * 992: 993: output title 994: 995: =item * 996: 997: get state of file attributes to be showing 998: 999: =item * 1000: 1001: output state of file attributes to be showing 1002: 1003: =item * 1004: 1005: output starting row to the indexed file/directory hierarchy 1006: 1007: =item * 1008: 1009: read in what directories have previously been set to "open" 1010: 1011: =item * 1012: 1013: if not at top level, provide an uplink arrow 1014: 1015: =item * 1016: 1017: recursively go through all the directories and output as appropriate 1018: 1019: =item * 1020: 1021: information useful for group import 1022: 1023: =item * 1024: 1025: end the tables 1026: 1027: =item * 1028: 1029: end the output and return 1030: 1031: =back 1032: 1033: =head1 OTHER SUBROUTINES 1034: 1035: =over 4 1036: 1037: =item * 1038: 1039: scanDir - recursive scan of a directory 1040: 1041: =item * 1042: 1043: get_list - get complete matched list based on the uri (returns an array) 1044: 1045: =item * 1046: 1047: match_ext - filters out files based on extensions (returns an array) 1048: 1049: =item * 1050: 1051: display_line - displays one line in appropriate table format 1052: 1053: =item * 1054: 1055: begin_form - prints the beginning of a form for directory or file link 1056: 1057: =item * 1058: 1059: start_fresh_session - settings whenever the user causes the indexer window 1060: to be launched 1061: 1062: =back 1063: 1064: =cut