1: # The LearningOnline Network with CAPA
2: # Directory Indexer
3: #
4: # $Id: lonindexer.pm,v 1.94 2004/03/26 19:35:59 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::lonsequence();
51: use Apache::Constants qw(:common);
52: use Apache::lonmeta;
53: use Apache::File;
54: use Apache::lonlocal;
55: use GDBM_File;
56:
57: # ---------------------------------------- variables used throughout the module
58: my %hash; # global user-specific gdbm file
59: my %dirs; # keys are directories, values are the open/close status
60: my %language; # has the reference information present in language.tab
61:
62: # ----- Values which are set by the handler subroutine and are accessible to
63: # ----- other methods.
64: my $extrafield; # default extra table cell
65: my $fnum; # file counter
66: my $dnum; # directory counter
67:
68: # ----- Used to include or exclude files with certain extensions.
69: my @Only = ();
70: my @Omit = ();
71:
72:
73: # ----------------------------- Handling routine called via Apache and mod_perl
74: sub handler {
75: my $r = shift;
76: my $c = $r->connection();
77: &Apache::loncommon::content_type($r,'text/html');
78: &Apache::loncommon::no_cache($r);
79: $r->send_http_header;
80: return OK if $r->header_only;
81: $fnum=0;
82: $dnum=0;
83:
84: # Deal with stupid global variables (is there a way around making
85: # these global to this package? It is just so wrong....)
86: undef (@Only);
87: undef (@Omit);
88:
89: # ------------------------------------- read in machine configuration variables
90: my $iconpath= $r->dir_config('lonIconsURL') . "/";
91: my $domain = $r->dir_config('lonDefDomain');
92: my $role = $r->dir_config('lonRole');
93: my $loadlim = $r->dir_config('lonLoadLim');
94: my $servadm = $r->dir_config('lonAdmEMail');
95: my $sysadm = $r->dir_config('lonSysEMail');
96: my $lonhost = $r->dir_config('lonHostID');
97: my $tabdir = $r->dir_config('lonTabDir');
98:
99: my $fileclr='#ffffe6';
100: my $line;
101: my (@attrchk,@openpath);
102: my $uri=$r->uri;
103:
104: # -------------------------------------- see if called from an interactive mode
105: # Get the parameters from the query string
106: &Apache::loncommon::get_unprocessed_cgi($ENV{'QUERY_STRING'},
107: ['catalogmode','launch','acts','mode','form','element',
108: 'only','omit','titleelement']);
109: #-------------------------------------------------------------------
110: my $closebutton='';
111: my $groupimportbutton='';
112: my $colspan='';
113:
114: $extrafield='';
115: my $diropendb =
116: "/home/httpd/perl/tmp/$ENV{'user.domain'}_$ENV{'user.name'}_indexer.db";
117: %hash = ();
118: {
119: my %dbfile;
120: if (tie(%dbfile,'GDBM_File',$diropendb,&GDBM_READER(),0640)) {
121: while(my($key,$value)=each(%dbfile)) {
122: $hash{$key}=$value;
123: }
124: untie(%dbfile);
125: }
126: }
127: {
128: if ($ENV{'form.launch'} eq '1') {
129: &start_fresh_session();
130: }
131: # -------------------- refresh environment with user database values (in %hash)
132: &setvalues(\%hash,'form.catalogmode',\%ENV,'form.catalogmode' );
133:
134: # --------------------- define extra fields and buttons in case of special mode
135: if ($ENV{'form.catalogmode'} eq 'interactive') {
136: $extrafield='<td bgcolor="'.$fileclr.'" valign="bottom">'.
137: '<a name="$anchor"><img src="'.$iconpath.'whitespace1.gif"'.
138: ' border="0" /></td>';
139: $colspan=" colspan='2' ";
140: my $cl=&mt('Close');
141: $closebutton=<<END;
142: <input type="button" name="close" value='$cl' onClick="self.close()">
143: END
144: }
145: elsif ($ENV{'form.catalogmode'} eq 'groupimport') {
146: $extrafield='<td bgcolor="'.$fileclr.'" valign="bottom">'.
147: '<a name="$anchor"><img src="'.$iconpath.'whitespace1.gif"'.
148: ' border="0" /></td>';
149: $colspan=" colspan='2' ";
150: my $cl=&mt('Close');
151: my $gi=&mt('Group Import');
152: $closebutton=<<END;
153: <input type="button" name="close" value='$cl' onClick="self.close()">
154: END
155: $groupimportbutton=<<END;
156: <input type="button" name="groupimport" value='$gi'
157: onClick="javascript:select_group()">
158: END
159: }
160: # Additions made by Matthew to make the browser a little easier to deal
161: # with in the future.
162: #
163: # $mode (at this time) indicates if we are in edit mode.
164: # $form is the name of the form that the URL is placed when the
165: # selection is made.
166: # $element is the name of the element in $formname which receives
167: # the URL.
168: #&Apache::lonxml::debug('Checking mode, form, element');
169: &setvalues(\%hash,'form.mode' ,\%ENV,'form.mode' );
170: &setvalues(\%hash,'form.form' ,\%ENV,'form.form' );
171: &setvalues(\%hash,'form.element' ,\%ENV,'form.element');
172: &setvalues(\%hash,'form.titleelement',\%ENV,'form.titleelement');
173: &setvalues(\%hash,'form.only' ,\%ENV,'form.only' );
174: &setvalues(\%hash,'form.omit' ,\%ENV,'form.omit' );
175:
176: # Deal with 'omit' and 'only'
177: if (exists $ENV{'form.omit'}) {
178: @Omit = split(',',$ENV{'form.omit'});
179: }
180: if (exists $ENV{'form.only'}) {
181: @Only = split(',',$ENV{'form.only'});
182: }
183:
184: my $mode = $ENV{'form.mode'};
185: my ($form,$element,$titleelement);
186: if ($mode eq 'edit' || $mode eq 'parmset') {
187: $form = $ENV{'form.form'};
188: $element = $ENV{'form.element'};
189: $titleelement = $ENV{'form.titleelement'};
190: }
191: #&Apache::lonxml::debug("mode=$mode form=$form element=$element 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: my $obs;
566: $indent++;
567: my %dupdirs = %dirs;
568: my @list=&get_list($r,$startdir);
569: foreach my $line (@list) {
570: return if ($c->aborted());
571: #This is a kludge, sorry aboot this
572: my ($strip,$dom,undef,$testdir,undef,undef,undef,undef,undef,undef,undef,undef,undef,undef,$obs,undef)=split(/\&/,$line,16);
573: next if($strip =~ /.*\.meta$/ | $obs eq '1');
574: my (@fileparts) = split(/\./,$strip);
575: if ($hash{'display_attrs_9'} != 1) {
576: if (scalar(@fileparts) >= 3) {
577: my $fext = pop @fileparts;
578: my $ov = pop @fileparts;
579: my $fname = join ('.',@fileparts,$fext);
580: next if (grep /\Q$fname\E/,@list and $ov =~ /^\d+$/);
581: }
582: }
583:
584: if ($dom eq 'domain') {
585: # dom list has full path /res/<domain name>/ already
586: $curdir='';
587: $compuri = (split(/\&/,$line))[0];
588: } else {
589: # user, dir & file have name only, i.e., w/o path
590: $compuri = join('',$startdir,$strip,'/');
591: $curdir = $startdir;
592: }
593: my $diropen = 'closed';
594: if (($dirptr&$testdir) or ($dom =~ /^(domain|user)$/)) {
595: while (my ($key,$val)= each %dupdirs) {
596: if ($key eq $compuri and $val eq "open") {
597: $diropen = "opened";
598: delete($dupdirs{$key});
599: delete($dirs{$key});
600: }
601: }
602: }
603: &display_line($r,$diropen,$line,$indent,$curdir,$hashref,@list);
604: &scanDir ($r,$compuri,$indent) if $diropen eq 'opened';
605: }
606: $indent--;
607: }
608:
609: # --------------- get complete matched list based on the uri (returns an array)
610: sub get_list {
611: my ($r,$uri)=@_;
612: my @list;
613: (my $luri = $uri) =~ s/\//_/g;
614: if ($ENV{'form.updatedisplay'}) {
615: foreach (keys %hash) {
616: delete $hash{$_} if ($_ =~ /^dirlist_files_/);
617: }
618: }
619:
620: if ($hash{'dirlist_files_'.$luri}) {
621: @list = split(/\n/,$hash{'dirlist_files_'.$luri});
622: } elsif ($uri=~/\.(page|sequence)$/) {
623: # is a page or a sequence
624: @list= &Apache::lonsequence::attemptread(&Apache::lonnet::filelocation('',$uri));
625: $hash{'dirlist_files_'.$luri} = join("\n",@list);
626: } else {
627: # is really a directory
628: @list = &Apache::lonnet::dirlist($uri);
629: $hash{'dirlist_files_'.$luri} = join("\n",@list);
630: }
631: return @list=&match_ext($r,@list);
632: }
633:
634: sub initdebug {
635: return <<ENDJS;
636: <script>
637: var debugging = true;
638: if (debugging) {
639: var debuggingWindow = window.open('','Debug','width=400,height=300',true);
640: }
641:
642: function output(text) {
643: if (debugging) {
644: debuggingWindow.document.writeln(text);
645: }
646: }
647: output("<html><head><title>Debugging Window</title></head><body><pre>");
648: </script>
649: ENDJS
650: }
651:
652: sub writedebug {
653: my $text = shift;
654: return "<script>output('$text');</script>";
655: }
656:
657: # -------------------- filters out files based on extensions (returns an array)
658: sub match_ext {
659: my ($r,@packlist)=@_;
660: my @trimlist;
661: my $nextline;
662: my @fileext;
663: my $dirptr=16384;
664:
665: foreach my $line (@packlist) {
666: chomp $line;
667: $line =~ s/^\/home\/httpd\/html//;
668: my @unpackline = split (/\&/,$line);
669: next if ($unpackline[0] eq '.');
670: next if ($unpackline[0] eq '..');
671: my @filecom = split (/\./,$unpackline[0]);
672: my $fext = pop(@filecom);
673: my $fnptr = $unpackline[3]&$dirptr;
674: if ($fnptr == 0 and $unpackline[3] ne "") {
675: my $embstyle = &Apache::loncommon::fileembstyle($fext);
676: push @trimlist,$line if (defined($embstyle) &&
677: ($embstyle ne 'hdn' or $fext eq 'meta'));
678: } else {
679: push @trimlist,$line;
680: }
681: }
682: @trimlist = sort {uc($a) cmp uc($b)} (@trimlist);
683: return @trimlist;
684: }
685:
686: # ------------------------------- displays one line in appropriate table format
687: sub display_line {
688: my ($r,$diropen,$line,$indent,$startdir,$hashref,@list)=@_;
689: my (@pathfn, $fndir);
690: my $dirptr=16384;
691: my $fileclr="#ffffe6";
692: my $iconpath= $r->dir_config('lonIconsURL') . '/';
693:
694: my @filecom = split (/\&/,$line);
695: my @pathcom = split (/\//,$filecom[0]);
696: my $listname = $pathcom[scalar(@pathcom)-1];
697: my $fnptr = $filecom[3]&$dirptr;
698: my $msg = &mt('View').' '.$filecom[0].' '.&mt('resources');
699: $msg = &mt('Close').' '.$filecom[0].' '.&mt('directory') if $diropen eq 'opened';
700:
701: my $tabtag='</td>';
702: my $i=0;
703: while ($i<=8) {
704: $tabtag=join('',$tabtag,"<td> </td>")
705: if $hash{'display_attrs_'.$i} == 1;
706: $i++;
707: }
708:
709: my $valign = ($hash{'display_attrs_7'} == 1 ? 'top' : 'bottom');
710:
711: # display uplink arrow
712: if ($filecom[1] eq 'viewOneUp') {
713: $r->print("<tr valign='$valign' bgcolor=$fileclr>$extrafield");
714: $r->print("<td>\n");
715: $r->print ('<form method="post" name="dirpathUP" action="'.$startdir.
716: '/" '.
717: 'onSubmit="return rep_dirpath(\'UP\','.
718: 'document.forms.fileattr.acts.value)" '.
719: 'enctype="application/x-www-form-urlencoded"'.
720: '>'."\n");
721: $r->print ('<input type=hidden name=openuri value="'.
722: $startdir.'">'."\n");
723: $r->print ('<input type="hidden" name="acts" value="">'."\n");
724: $r->print ('<input src="'.$iconpath.'arrow_up.gif"');
725: $r->print (' name="'.$msg.'" height="22" type="image" border="0">'.
726: "\n");
727: $r->print(&mt("Up")." $tabtag</tr></form>\n");
728: return OK;
729: }
730: # Do we have permission to look at this?
731: if($filecom[15] ne '1') { return OK if (!&Apache::lonnet::allowed('bre',$startdir.$filecom[0])); }
732:
733: # display domain
734: if ($filecom[1] eq 'domain') {
735: $r->print ('<input type="hidden" name="dirPointer" value="on">'."\n")
736: if ($ENV{'form.dirPointer'} eq "on");
737: $r->print("<tr valign='$valign' bgcolor=$fileclr>$extrafield");
738: $r->print("<td>");
739: &begin_form ($r,$filecom[0]);
740: my $anchor = $filecom[0];
741: $anchor =~ s/\///g;
742: $r->print ('<a name="'.$anchor.'">');
743: $r->print ('<input type="hidden" name="acts" value="">');
744: $r->print ('<input src="'.$iconpath.'folder_pointer_'.
745: $diropen.'.gif"');
746: $r->print (' name="'.$msg.'" height="22" type="image" border="0">'.
747: "\n");
748: $r->print ('<a href="javascript:gothere(\''.$filecom[0].
749: '\')"><img src="'.$iconpath.'server.gif"');
750: $r->print (' border="0" /></a>'."\n");
751: $r->print (&mt("Domain")." - $listname ");
752: if ($Apache::lonnet::domaindescription{$listname}) {
753: $r->print("(".$Apache::lonnet::domaindescription{$listname}.
754: ")");
755: }
756: $r->print (" $tabtag</tr></form>\n");
757: return OK;
758:
759: # display user directory
760: }
761: if ($filecom[1] eq 'user') {
762: $r->print("<tr valign=$valign bgcolor=$fileclr>$extrafield");
763: $r->print("<td nowrap>\n");
764: my $curdir = $startdir.$filecom[0].'/';
765: my $anchor = $curdir;
766: $anchor =~ s/\///g;
767: &begin_form ($r,$curdir);
768: $r->print ('<a name="'.$anchor.'"><img src="'.$iconpath.
769: 'whitespace1.gif" border="0" />'."\n");
770: $r->print ('<input type="hidden" name="acts" value="">');
771: $r->print ('<input src="'.$iconpath.'folder_pointer_'.$diropen.
772: '.gif"');
773: $r->print (' name="'.$msg.'" height="22" type="image" border="0">'.
774: "\n");
775: $r->print ('<a href="javascript:gothere(\''.$curdir.'\')"><img src='.
776: $iconpath.'quill.gif border="0" name="'.$msg.
777: '" height="22" /></a>');
778: my $domain=(split(m|/|,$startdir))[2];
779: my $plainname=&Apache::loncommon::plainname($listname,$domain);
780: $r->print ($listname);
781: if (defined($plainname) && $plainname) { $r->print(" ($plainname) "); }
782: $r->print ($tabtag.'</tr></form>'."\n");
783: return OK;
784: }
785:
786: # display file
787: if ($fnptr == 0 and $filecom[3] ne '') {
788: my $filelink = $startdir.$filecom[0];
789: my @file_ext = split (/\./,$listname);
790: my $curfext = $file_ext[-1];
791: if (@Omit) {
792: foreach (@Omit) { return OK if ($curfext eq $_); }
793: }
794: if (@Only) {
795: my $skip = 1;
796: foreach (@Only) { $skip = 0 if ($curfext eq $_); }
797: return OK if ($skip > 0);
798: }
799: # Set the icon for the file
800: my $iconname = &Apache::loncommon::icon($listname);
801: $r->print("<tr valign='$valign' bgcolor=$fileclr><td nowrap>");
802: my $metafile = grep /^\Q$filecom[0]\E\.meta\&/, @list;
803: my $title;
804: if ($ENV{'form.catalogmode'} eq 'interactive') {
805: $title=$listname;
806: $title = &Apache::lonnet::metadata($filelink,'title')
807: if ($metafile == 1);
808: $title=$listname unless $title;
809: my $titleesc=HTML::Entities::encode($title);
810: $titleesc=~s/\'/\\'/; #' (clean up this spare quote)
811: $r->print("<a href=\"javascript:select_data(\'",
812: $titleesc,"','",$filelink,"')\">");
813: $r->print("<img src='",$iconpath,"select.gif' border='0' /></a>".
814: "\n");
815: $r->print("</td><td nowrap>");
816: }
817: elsif ($ENV{'form.catalogmode'} eq 'groupimport') {
818: $title=$listname;
819: #$title = &Apache::lonnet::metadata($filelink,'title')
820: #if ($metafile == 1);
821: $title=$listname unless $title;
822: my $titleesc=&HTML::Entities::encode($title);
823: $r->print("<form name='form$fnum'>\n");
824: $r->print("<input type='checkbox' name='filelink"."' ".
825: "value='$filelink' onClick='".
826: "javascript:queue(\"form$fnum\")' ");
827: if ($hash{'store_'.$filelink}) {
828: $r->print("checked");
829: }
830: $r->print(">\n");
831: $r->print("<input type='hidden' name='title"."' ".
832: "value='$titleesc'>\n");
833: $r->print("</form>\n");
834: $r->print("</td><td nowrap>");
835: $hash{"pre_${fnum}_link"}=$filelink;
836: $hash{"pre_${fnum}_title"}=$titleesc;
837: $fnum++;
838: }
839:
840: if ($indent > 0 and $indent < 11) {
841: $r->print("<img src=",$iconpath,"whitespace",$indent,
842: ".gif border='0' />\n");
843: } elsif ($indent >0) {
844: my $ten = int($indent/10.);
845: my $rem = $indent%10.0;
846: my $count = 0;
847: while ($count < $ten) {
848: $r->print("<img src=",$iconpath,
849: "whitespace10.gif border='0' />\n");
850: $count++;
851: }
852: $r->print("<img src=",$iconpath,"whitespace",$rem,
853: ".gif border='0' />\n") if $rem > 0;
854: }
855:
856: $r->print("<img src='$iconname' border='0' />\n");
857: $r->print (" <a href=\"javascript:openWindow('".$filelink.
858: "', 'previewfile', '450', '500', 'no', 'yes','yes')\";".
859: " TARGET=_self>$listname</a> ");
860:
861: $r->print (" (<a href=\"javascript:openWindow('".$filelink.
862: ".meta', 'metadatafile', '500', '550', 'no', 'yes','no')\"; ".
863: "TARGET=_self>metadata</a>) ") if ($metafile == 1);
864:
865: $r->print("</td>\n");
866: if ($hash{'display_attrs_0'} == 1) {
867: my $title = &Apache::lonnet::gettitle($filelink,'title')
868: if ($metafile == 1);
869: $r->print('<td> '.($title eq '' ? ' ' : $title).
870: ' </td>'."\n");
871: }
872: $r->print('<td align=right> ',
873: $filecom[8]," </td>\n")
874: if $hash{'display_attrs_1'} == 1;
875: $r->print('<td> '.
876: (localtime($filecom[9]))." </td>\n")
877: if $hash{'display_attrs_2'} == 1;
878: $r->print('<td> '.
879: (localtime($filecom[10]))." </td>\n")
880: if $hash{'display_attrs_3'} == 1;
881:
882: if ($hash{'display_attrs_4'} == 1) {
883: my $author = &Apache::lonnet::metadata($filelink,'author')
884: if ($metafile == 1);
885: $r->print('<td> '.($author eq '' ? ' ' : $author).
886: " </td>\n");
887: }
888: if ($hash{'display_attrs_5'} == 1) {
889: my $keywords = &Apache::lonnet::metadata($filelink,'keywords')
890: if ($metafile == 1);
891: # $keywords = ' ' if (!$keywords);
892: $r->print('<td> '.($keywords eq '' ? ' ' : $keywords).
893: " </td>\n");
894: }
895: if ($hash{'display_attrs_6'} == 1) {
896: my $lang = &Apache::lonnet::metadata($filelink,'language')
897: if ($metafile == 1);
898: $lang = &Apache::loncommon::languagedescription($lang);
899: $r->print('<td> '.($lang eq '' ? ' ' : $lang).
900: " </td>\n");
901: }
902: if ($hash{'display_attrs_7'} == 1) {
903: my $output='';
904: my $embstyle=&Apache::loncommon::fileembstyle($curfext);
905: if ($embstyle eq 'ssi') {
906: my $cache=$Apache::lonnet::perlvar{'lonDocRoot'}.$filelink.
907: '.tmp';
908: if ((!$ENV{'form.updatedisplay'}) &&
909: (-e $cache)) {
910: open(FH,$cache);
911: $output=join("\n",<FH>);
912: close(FH);
913: } else {
914: $output=&Apache::lonnet::ssi_body($filelink);
915: open(FH,">$cache");
916: print FH $output;
917: close(FH);
918: }
919: $output='<font size="-2">'.$output.'</font>';
920: } elsif ($embstyle eq 'img') {
921: $output='<img src="'.$filelink.'" />';
922: } elsif ($filelink=~/^\/res\/(\w+)\/(\w+)\//) {
923: $output='<img src="http://'.
924: $Apache::lonnet::hostname{&Apache::lonnet::homeserver($2,$1)}.
925: '/cgi-bin/thumbnail.gif?url='.$filelink.'" />';
926: }
927: $r->print('<td> '.($output eq '' ? ' ':$output).
928: " </td>\n");
929: }
930: if ($hash{'display_attrs_8'} == 1) {
931: my (%stat) = &Apache::lonmeta::dynamicmeta($filelink) if ($metafile == 1);
932: my $stat = (exists($stat{'course'}) ? $stat{'course'} : '').
933: ((exists($stat{'course'}) || exists($stat{'count'})) ? '/' : '').
934: (exists($stat{'count'}) ? $stat{'count'} : '');
935: $r->print('<td align=center> '.($stat eq '' ? ' ' : $stat).
936: ' </td>'."\n");
937: }
938:
939: $r->print("</tr>\n");
940: }
941:
942: # -- display directory
943: if ($fnptr == $dirptr) {
944: my $curdir = $startdir.$filecom[0].'/';
945: my $anchor = $curdir;
946: $anchor =~ s/\///g;
947: $r->print("<tr bgcolor=$fileclr>$extrafield<td valign=$valign>");
948: &begin_form ($r,$curdir);
949: my $indentm1 = $indent-1;
950: if ($indentm1 < 11 and $indentm1 > 0) {
951: $r->print("<img src=",$iconpath,"whitespace",$indentm1,
952: ".gif border='0' />\n");
953: } else {
954: my $ten = int($indentm1/10.);
955: my $rem = $indentm1%10.0;
956: my $count = 0;
957: while ($count < $ten) {
958: $r->print ("<img src=",$iconpath
959: ,"whitespace10.gif border='0' />\n");
960: $count++;
961: }
962: $r->print ("<img src=",$iconpath,"whitespace",$rem,
963: ".gif border='0' />\n") if $rem > 0;
964: }
965: $r->print ('<input type="hidden" name="acts" value="">');
966: $r->print ('<a name="'.$anchor.'"><input src="'.$iconpath.
967: 'folder_pointer_'.$diropen.'.gif"');
968: $r->print (' name="'.$msg.'" height="22" type="image" border="0">'.
969: "\n");
970: $r->print ('<a href="javascript:gothere(\''.$curdir.'\')"><img src="'.
971: $iconpath.'folder_'.$diropen.'.gif" border="0" /></a>'.
972: "\n");
973: $r->print ("$listname</td>\n");
974: # Attributes
975: my $filelink = $startdir.$filecom[0].'/default';
976:
977: if ($hash{'display_attrs_0'} == 1) {
978: my $title = &Apache::lonnet::gettitle($filelink,'title');
979: $r->print('<td> '.($title eq '' ? ' ' : $title).
980: ' </td>'."\n");
981: }
982: $r->print('<td align=right> ',
983: $filecom[8]," </td>\n")
984: if $hash{'display_attrs_1'} == 1;
985: $r->print('<td> '.
986: (localtime($filecom[9]))." </td>\n")
987: if $hash{'display_attrs_2'} == 1;
988: $r->print('<td> '.
989: (localtime($filecom[10]))." </td>\n")
990: if $hash{'display_attrs_3'} == 1;
991:
992: if ($hash{'display_attrs_4'} == 1) {
993: my $author = &Apache::lonnet::metadata($filelink,'author');
994: $r->print('<td> '.($author eq '' ? ' ' : $author).
995: " </td>\n");
996: }
997: if ($hash{'display_attrs_5'} == 1) {
998: my $keywords = &Apache::lonnet::metadata($filelink,'keywords');
999: # $keywords = ' ' if (!$keywords);
1000: $r->print('<td> '.($keywords eq '' ? ' ' : $keywords).
1001: " </td>\n");
1002: }
1003: if ($hash{'display_attrs_6'} == 1) {
1004: my $lang = &Apache::lonnet::metadata($filelink,'language');
1005: $lang = &Apache::loncommon::languagedescription($lang);
1006: $r->print('<td> '.($lang eq '' ? ' ' : $lang).
1007: " </td>\n");
1008: }
1009: if ($hash{'display_attrs_7'} == 1) {
1010: $r->print('<td> </td>');
1011: }
1012: if ($hash{'display_attrs_8'} == 1) {
1013: $r->print('<td> </td>');
1014: }
1015: $r->print('</form></tr>');
1016: }
1017:
1018: }
1019:
1020: # ------------------- prints the beginning of a form for directory or file link
1021: sub begin_form {
1022: my ($r,$uri) = @_;
1023: my $anchor = $uri;
1024: $anchor =~ s/\///g;
1025: $r->print ('<form method="post" name="dirpath'.$dnum.'" action="'.$uri.
1026: '#'.$anchor.
1027: '" onSubmit="return rep_dirpath(\''.$dnum.'\''.
1028: ',document.forms.fileattr.acts.value)" '.
1029: 'enctype="application/x-www-form-urlencoded">'."\n");
1030: $r->print ('<input type="hidden" name="openuri" value="'.$uri.'">'.
1031: "\n");
1032: $r->print ('<input type="hidden" name="dirPointer" value="on">'."\n");
1033: $dnum++;
1034: }
1035:
1036: # --------- settings whenever the user causes the indexer window to be launched
1037: sub start_fresh_session {
1038: delete $hash{'form.catalogmode'};
1039: delete $hash{'form.mode'};
1040: delete $hash{'form.form'};
1041: delete $hash{'form.element'};
1042: delete $hash{'form.omit'};
1043: delete $hash{'form.only'};
1044: foreach (keys %hash) {
1045: delete $hash{$_} if (/^(pre_|store)/);
1046: }
1047: }
1048:
1049: # ------------------------------------------------------------------- setvalues
1050: sub setvalues {
1051: # setvalues is used in registerurl to synchronize the database
1052: # hash and environment hashes
1053: my ($H1,$h1key,$H2,$h2key) =@_;
1054: #
1055: if (exists $H2->{$h2key}) {
1056: $H1->{$h1key} = $H2->{$h2key};
1057: } elsif (exists $H1->{$h1key}) {
1058: $H2->{$h2key} = $H1->{$h1key};
1059: }
1060: }
1061:
1062: 1;
1063:
1064: sub cleanup {
1065: if (tied(%hash)){
1066: &Apache::lonnet::logthis('Cleanup indexer: hash');
1067: }
1068: }
1069:
1070: =head1 NAME
1071:
1072: Apache::lonindexer - mod_perl module for cross server filesystem browsing
1073:
1074: =head1 SYNOPSIS
1075:
1076: Invoked by /etc/httpd/conf/srm.conf:
1077:
1078: <LocationMatch "^/res.*/$">
1079: SetHandler perl-script
1080: PerlHandler Apache::lonindexer
1081: </LocationMatch>
1082:
1083: =head1 INTRODUCTION
1084:
1085: This module enables a scheme of browsing across a cross server.
1086:
1087: This is part of the LearningOnline Network with CAPA project
1088: described at http://www.lon-capa.org.
1089:
1090: =head1 BEGIN SUBROUTINE
1091:
1092: This routine is only run once after compilation.
1093:
1094: =over 4
1095:
1096: =item *
1097:
1098: Initializes %language hash table.
1099:
1100: =back
1101:
1102: =head1 HANDLER SUBROUTINE
1103:
1104: This routine is called by Apache and mod_perl.
1105:
1106: =over 4
1107:
1108: =item *
1109:
1110: read in machine configuration variables
1111:
1112: =item *
1113:
1114: see if called from an interactive mode
1115:
1116: =item *
1117:
1118: refresh environment with user database values (in %hash)
1119:
1120: =item *
1121:
1122: define extra fields and buttons in case of special mode
1123:
1124: =item *
1125:
1126: set catalogmodefunctions to have extra needed javascript functionality
1127:
1128: =item *
1129:
1130: print header
1131:
1132: =item *
1133:
1134: evaluate actions from previous page (both cumulatively and chronologically)
1135:
1136: =item *
1137:
1138: output title
1139:
1140: =item *
1141:
1142: get state of file attributes to be showing
1143:
1144: =item *
1145:
1146: output state of file attributes to be showing
1147:
1148: =item *
1149:
1150: output starting row to the indexed file/directory hierarchy
1151:
1152: =item *
1153:
1154: read in what directories have previously been set to "open"
1155:
1156: =item *
1157:
1158: if not at top level, provide an uplink arrow
1159:
1160: =item *
1161:
1162: recursively go through all the directories and output as appropriate
1163:
1164: =item *
1165:
1166: information useful for group import
1167:
1168: =item *
1169:
1170: end the tables
1171:
1172: =item *
1173:
1174: end the output and return
1175:
1176: =back
1177:
1178: =head1 OTHER SUBROUTINES
1179:
1180: =over 4
1181:
1182: =item *
1183:
1184: scanDir - recursive scan of a directory
1185:
1186: =item *
1187:
1188: get_list - get complete matched list based on the uri (returns an array)
1189:
1190: =item *
1191:
1192: match_ext - filters out files based on extensions (returns an array)
1193:
1194: =item *
1195:
1196: display_line - displays one line in appropriate table format
1197:
1198: =item *
1199:
1200: begin_form - prints the beginning of a form for directory or file link
1201:
1202: =item *
1203:
1204: start_fresh_session - settings whenever the user causes the indexer window
1205: to be launched
1206:
1207: =back
1208:
1209: =cut
FreeBSD-CVSweb <freebsd-cvsweb@FreeBSD.org>