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