loncom/interface/lonindexer.pm - view

File: [LON-CAPA] / loncom / interface / lonindexer.pm
Revision 1.72: download - view: text, annotated - select for diffs
Wed Aug 6 16:43:36 2003 UTC (20 years, 10 months ago) by albertel
Branches: MAIN
CVS tags: version_0_99_4, HEAD

1. When list /res there is no reason to do any network calls, as it was
   we were trying to do bre checks on /res/msu//res/msu
   which is
    a) wrong
    b) doesn't have a trailing / so metdata tried to get metadata
       which meant we tried to do a repcopy, which meant we tried to find what home server
       user res in domain msu was on which is
        i) stupid
        ii) kinda funny
        iii) cuased us to try to do a network call to everymachine
2. Fixes BUG1963, since we no longer make any network calls when listing /res

3. Have I mentioned how much I love the caller function. Introspection is so much fun.

4. One last line in an attempt to pad out my commit message

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