1: # The LearningOnline Network with CAPA
2: # Handler to rename files, etc, in construction space
3: #
4: # This file responds to the various buttons and events
5: # in the top frame of the construction space directory.
6: # Each event is processed in two phases. The first phase
7: # presents a page that describes the proposed action to the user
8: # and requests confirmation. The second phase commits the action
9: # and displays a page showing the results of the action.
10: #
11: #
12: # $Id: loncfile.pm,v 1.93 2009/01/29 11:50:32 bisitz Exp $
13: #
14: # Copyright Michigan State University Board of Trustees
15: #
16: # This file is part of the LearningOnline Network with CAPA (LON-CAPA).
17: #
18: # LON-CAPA is free software; you can redistribute it and/or modify
19: # it under the terms of the GNU General Public License as published by
20: # the Free Software Foundation; either version 2 of the License, or
21: # (at your option) any later version.
22: #
23: # LON-CAPA is distributed in the hope that it will be useful,
24: # but WITHOUT ANY WARRANTY; without even the implied warranty of
25: # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
26: # GNU General Public License for more details.
27: #
28: # You should have received a copy of the GNU General Public License
29: # along with LON-CAPA; if not, write to the Free Software
30: # Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
31: #
32: # /home/httpd/html/adm/gpl.txt
33: #
34: # http://www.lon-capa.org/
35: #
36: =pod
37:
38: =head1 NAME
39:
40: Apache::loncfile - Construction space file management.
41:
42: =head1 SYNOPSIS
43:
44: Content handler for buttons on the top frame of the construction space
45: directory.
46:
47: =head1 INTRODUCTION
48:
49: loncfile is invoked when buttons in the top frame of the construction
50: space directory listing are clicked. All operations proceed in two phases.
51: The first phase describes to the user exactly what will be done. If the user
52: confirms the operation, the second phase commits the operation and indicates
53: completion. When the user dismisses the output of phase2, they are returned to
54: an "appropriate" directory listing in general.
55:
56: This is part of the LearningOnline Network with CAPA project
57: described at http://www.lon-capa.org.
58:
59: =head2 Subroutines
60:
61: =cut
62:
63: package Apache::loncfile;
64:
65: use strict;
66: use Apache::File;
67: use File::Basename;
68: use File::Copy;
69: use HTML::Entities();
70: use Apache::Constants qw(:common :http :methods);
71: use Apache::loncacc;
72: use Apache::lonnet;
73: use Apache::loncommon();
74: use Apache::lonlocal;
75: use LONCAPA qw(:DEFAULT :match);
76:
77:
78: my $DEBUG=0;
79: my $r; # Needs to be global for some stuff RF.
80:
81: =pod
82:
83: =item Debug($request, $message)
84:
85: If debugging is enabled puts out a debugging message determined by the
86: caller. The debug message goes to the Apache error log file. Debugging
87: is enabled by setting the module global DEBUG variable to nonzero (TRUE).
88:
89: Parameters:
90:
91: =over 4
92:
93: =item $request - The current request operation.
94:
95: =item $message - The message to put in the log file.
96:
97: =back
98:
99: Returns:
100: nothing.
101:
102: =cut
103:
104: sub Debug {
105: # Put out the indicated message butonly if DEBUG is true.
106: if ($DEBUG) {
107: my ($r,$message) = @_;
108: $r->log_reason($message);
109: }
110: }
111:
112: sub done {
113: my ($url)=@_;
114: my $done=&mt("Done");
115: return(<<ENDDONE);
116: <a href="$url">$done</a>
117: <script type="text/javascript">
118: location.href="$url";
119: </script>
120: ENDDONE
121: }
122:
123: =pod
124:
125: =item URLToPath($url)
126:
127: Convert a URL to a file system path.
128:
129: In order to manipulate the construction space objects, it is necessary
130: to access url identified objects a filespace objects. This function
131: translates a construction space URL to a file system path.
132: Parameters:
133:
134: =over 4
135:
136: =item Url - string [in] The url to convert.
137:
138: =back
139:
140: Returns:
141:
142: =over 4
143:
144: =item The corresponding file system path.
145:
146: =back
147:
148: Global References
149:
150: =over 4
151:
152: =item $r - Request object [in] Referenced in the &Debug calls.
153:
154: =back
155:
156: =cut
157:
158: sub URLToPath {
159: my $Url = shift;
160: &Debug($r, "UrlToPath got: $Url");
161: $Url=~ s/\/+/\//g;
162: $Url=~ s/^https?\:\/\/[^\/]+//;
163: $Url=~ s/^\///;
164: $Url=~ s/(\~|priv\/)($match_username)\//\/home\/$2\/public_html\//;
165: &Debug($r, "Returning $Url \n");
166: return $Url;
167: }
168:
169: sub url {
170: my $fn=shift;
171: $fn=~s/^\/home\/($match_username)\/public\_html/\/priv\/$1/;
172: $fn=&HTML::Entities::encode($fn,'<>"&');
173: return $fn;
174: }
175:
176: sub display {
177: my $fn=shift;
178: $fn=~s-^/home/($match_username)/public_html-/priv/$1-;
179: return '<span class="LC_filename">'.$fn.'</span>';
180: }
181:
182:
183: # see if the file is
184: # a) published (return 0 if not)
185: # b) if, so obsolete (return 0 if not)
186:
187: sub obsolete_unpub {
188: my ($user,$domain,$construct)=@_;
189: my $published=$construct;
190: $published=~
191: s/^\/home\/$user\/public\_html\//\/home\/httpd\/html\/res\/$domain\/$user\//;
192: if (-e $published) {
193: if (&Apache::lonnet::metadata($published,'obsolete')) {
194: return 1;
195: }
196: return 0;
197: } else {
198: return 1;
199: }
200: }
201:
202: # see if directory is empty
203: # ignores any .meta, .save, .bak, and .log files created for a previously
204: # published file, which has since been marked obsolete and deleted.
205: sub empty_directory {
206: my ($dirname,$phase) = @_;
207: if (opendir DIR, $dirname) {
208: my @files = grep(!/^\.\.?$/, readdir(DIR)); # ignore . and ..
209: if (@files) {
210: my @orphans = grep(/\.(meta|save|log|bak)$/,@files);
211: if (scalar(@files) - scalar(@orphans) > 0) {
212: return 0;
213: } else {
214: if (($phase eq 'Delete2') && (@orphans > 0)) {
215: foreach my $file (@orphans) {
216: if ($file =~ /\.(meta|save|log|bak)$/) {
217: unlink($dirname.$file);
218: }
219: }
220: }
221: }
222: }
223: closedir(DIR);
224: return 1;
225: }
226: return 0;
227: }
228:
229: =pod
230:
231: =item exists($user, $domain, $file)
232:
233: Determine if a resource file name has been published or exists
234: in the construction space.
235:
236: Parameters:
237:
238: =over 4
239:
240: =item $user - string [in] - Name of the user for which to check.
241:
242: =item $domain - string [in] - Name of the domain in which the resource
243: might have been published.
244:
245: =item $file - string [in] - Name of the file.
246:
247: =item $creating - string [in] - optional, type of object being created,
248: either 'directory' or 'file'. Defaults to
249: 'file' if unspecified.
250:
251: =back
252:
253: Returns:
254:
255: =over 4
256:
257: =item string - Either undef, 'warning' or 'error' depending on the
258: type of problem
259:
260: =item string - Either where the resource exists as an html string that can
261: be embedded in a dialog or an empty string if the resource
262: does not exist.
263:
264: =back
265:
266: =cut
267:
268: sub exists {
269: my ($user, $domain, $construct, $creating) = @_;
270: $creating ||= 'file';
271:
272: my $published=$construct;
273: $published=~
274: s{^/home/$user/public_html/}{/home/httpd/html/res/$domain/$user/};
275: my ($type,$result);
276: if ( -d $construct ) {
277: return ('error','<p><span class="LC_error">'.&mt('Error: destination for operation is an existing directory.').'</span></p>');
278:
279: }
280:
281: if ( -e $published) {
282: if ( -e $construct ) {
283: $type = 'warning';
284: $result.='<p><span class="LC_warning">'.&mt('Warning: target file exists, and has been published!').'</span></p>';
285: } else {
286: my $published_type = (-d $published) ? 'directory' : 'file';
287:
288: if ($published_type eq $creating) {
289: $type = 'warning';
290: $result.='<p><span class="LC_warning">'.&mt("Warning: a published $published_type of this name exists.").'</span></p>';
291: } else {
292: $type = 'error';
293: $result.='<p><span class="LC_error">'.&mt("Error: a published $published_type of this name exists.").'</span></p>';
294: }
295: }
296: } elsif ( -e $construct) {
297: $type = 'warning';
298: $result.='<p><span class="LC_warning">'.&mt('Warning: target file exists!').'</span></p>';
299: }
300:
301: return ($type,$result);
302: }
303:
304: =pod
305:
306: =item checksuffix($old, $new)
307:
308: Determine if a resource filename suffix (the stuff after the .) would change
309: as a result of this operation.
310:
311: Parameters:
312:
313: =over 4
314:
315: =item $old = string [in] Previous filename.
316:
317: =item $new = string [in] Resultant filename.
318:
319: =back
320:
321: Returns:
322:
323: =over 4
324:
325: =item Empty string if everything worked.
326:
327: =item String containing an error message if there was a problem.
328:
329: =back
330:
331: =cut
332:
333: sub checksuffix {
334: my ($old,$new) = @_;
335: my $result;
336: my $oldsuffix;
337: my $newsuffix;
338: if ($new=~m:(.*/*)([^/]+)\.(\w+)$:) { $newsuffix=$3; }
339: if ($old=~m:(.*)/+([^/]+)\.(\w+)$:) { $oldsuffix=$3; }
340: if (lc($oldsuffix) ne lc($newsuffix)) {
341: $result.=
342: '<p><span class="LC_warning">'.&mt('Warning: change of MIME type!').'</span></p>';
343: }
344: return $result;
345: }
346:
347: sub cleanDest {
348: my ($request,$dest,$subdir,$fn,$uname)=@_;
349: #remove bad characters
350: my $foundbad=0;
351: if ($subdir && $dest =~/\./) {
352: $foundbad=1;
353: $dest=~s/\.//g;
354: }
355: $dest =~ s/(\s+$|^\s+)//g;
356: if ($dest=~/[\#\?&%\":]/) {
357: $foundbad=1;
358: $dest=~s/[\#\?&%\":]//g;
359: }
360: if ($dest=~m|/|) {
361: my ($newpath)=($dest=~m|(.*)/|);
362: $newpath=&relativeDest($fn,$newpath,$uname);
363: if (! -d "$newpath") {
364: $request->print('<p><span class="LC_error">'
365: .&mt("You have requested to create file in directory [_1] which doesn't exist. The requested directory path has been removed from the requested file name."
366: ,'"'.&display($newpath).'"')
367: .'</span></p>');
368: $dest=~s|.*/||;
369: }
370: }
371: if ($dest =~ /\.(\d+)\.(\w+)$/){
372: $request->print('<span class="LC_error">'
373: .&mt('Bad filename [_1]','<span class="LC_filename">'.&display($dest).'</span>')
374: .'<br />'
375: .&mt('[_1](name).(number).(extension)[_2] not allowed.','<tt>','</tt>')
376: .'<br />'
377: .&mt('Removing the [_1].number.[_2] from requested filename.','<tt>','</tt>')
378: .'</span>');
379: $dest =~ s/\.(\d+)(\.\w+)$/$2/;
380: }
381: if ($foundbad) {
382: $request->print("<p><span class=\"LC_error\">".&mt('Invalid characters in requested name have been removed.')."</span></p>");
383: }
384: return $dest;
385: }
386:
387: sub relativeDest {
388: my ($fn,$newfilename,$uname)=@_;
389: if ($newfilename=~/^\//) {
390: # absolute, simply add path
391: $newfilename='/home/'.$uname.'/public_html/';
392: } else {
393: my $dir=$fn;
394: $dir=~s/\/[^\/]+$//;
395: $newfilename=$dir.'/'.$newfilename;
396: }
397: $newfilename=~s://+:/:g; # remove duplicate /
398: while ($newfilename=~m:/\.\./:) {
399: $newfilename=~ s:/[^/]+/\.\./:/:g; #remove dir/..
400: }
401: return $newfilename;
402: }
403:
404: =pod
405:
406: =item CloseForm1($request, $user, $file)
407:
408: Close of a form on the successful completion of phase 1 processing
409:
410: Parameters:
411:
412: =over 4
413:
414: =item $request - Apache Request Object [in] - Apache server request object.
415:
416: =item $cancelurl - the url to go to on cancel.
417:
418: =back
419:
420: =cut
421:
422: sub CloseForm1 {
423: my ($request, $fn) = @_;
424: $request->print('<p><input type="submit" value="'.&mt('Continue').'" /></p></form>');
425: $request->print('<form action="'.&url($fn).
426: '" method="POST"><p><input type="submit" value="'.&mt('Cancel').'" /></p></form>');
427: }
428:
429:
430: =pod
431:
432: =item CloseForm2($request, $user, $directory)
433:
434: Successfully close off the phase 2 form.
435:
436: Parameters:
437:
438: =over 4
439:
440: =item $request - Apache Request object [in] - The request that is being
441: executed.
442:
443: =item $user - string [in] - Name of the user that is initiating the
444: request.
445:
446: =item $directory - string [in] - Directory in which the operation is
447: being done relative to the top level construction space
448: directory.
449:
450: =back
451:
452: =cut
453:
454: sub CloseForm2 {
455: my ($request, $user, $fn) = @_;
456: $request->print(&done(&url($fn)));
457: }
458:
459: =pod
460:
461: =item Rename1($request, $filename, $user, $domain, $dir)
462:
463: Perform phase 1 processing of the file rename operation.
464:
465: Parameters:
466:
467: =over 4
468:
469: =item $request - Apache Request Object [in] The request object for the
470: current request.
471:
472: =item $filename - The filename relative to construction space.
473:
474: =item $user - Name of the user making the request.
475:
476: =item $domain - User login domain.
477:
478: =item $dir - Directory specification of the path to the file.
479:
480: =back
481:
482: Side effects:
483:
484: =over 4
485:
486: =item A new form is displayed prompting for confirmation. The newfilename
487: hidden field of this form is loaded with
488: new filename relative to the current directory ($dir).
489:
490: =back
491:
492: =cut
493:
494: sub Rename1 {
495: my ($request, $user, $domain, $fn, $newfilename, $style) = @_;
496:
497: if(-e $fn) {
498: if($newfilename) {
499: # is dest a dir
500: if ($style eq 'move') {
501: if (-d $newfilename) {
502: if ($fn =~ m|/([^/]*)$|) { $newfilename .= '/'.$1; }
503: }
504: }
505: if ($newfilename =~ m|/[^\.]+$|) {
506: #no extension add on original extension
507: if ($fn =~ m|/[^\.]*\.([^\.]+)$|) {
508: $newfilename.='.'.$1;
509: }
510: }
511: $request->print(&checksuffix($fn, $newfilename));
512: #renaming a dir, delete the trailing /
513: #remove second to last element for current dir
514: if (-d $fn) {
515: $newfilename=~/\.(\w+)$/;
516: if (&Apache::loncommon::fileembstyle($1) eq 'ssi') {
517: $request->print('<br /><span classr="LC_warning">'.
518: &mt('Cannot change MIME type of a directory').
519: '</span>'.
520: '<br /><a href="'.&url($fn).'">'.&mt('Cancel').'</a>');
521: return;
522: }
523: $newfilename=~s/\/[^\/]+\/([^\/]+)$/\/$1/;
524: }
525: $newfilename=~s://+:/:g; # remove duplicate /
526: while ($newfilename=~m:/\.\./:) {
527: $newfilename=~ s:/[^/]+/\.\./:/:g; #remove dir/..
528: }
529: my ($type, $return)=&exists($user, $domain, $newfilename);
530: $request->print($return);
531: if ($type eq 'error') {
532: $request->print('<br /><a href="'.&url($fn).'">'.&mt('Cancel').'</a>');
533: return;
534: }
535: unless (&obsolete_unpub($user,$domain,$fn)) {
536: $request->print('<h3>'.&mt('Cannot rename or move non-obsolete published file').'</h3>'.
537: '<br /><a href="'.&url($fn).'">'.&mt('Cancel').'</a>');
538: return;
539: }
540: my $action;
541: if ($style eq 'rename') {
542: $action=&mt('Rename');
543: } else {
544: $action=&mt('Move');
545: }
546: $request->print('<input type="hidden" name="newfilename" value="'.
547: $newfilename.
548: '" /><p>'.$action.' '.&display($fn).
549: '</p><br />to '.&display($newfilename).'?</p>');
550: &CloseForm1($request, $fn);
551: } else {
552: $request->print('<p>'.&mt('No new filename specified.').'</p></form>');
553: return;
554: }
555: } else {
556: $request->print('<p> '.&mt('No such file').': '.&display($fn).'</p></form>');
557: return;
558: }
559:
560: }
561:
562: =pod
563:
564: =item Delete1
565:
566: Performs phase 1 processing of the delete operation. In phase one
567: we just check to be sure the file exists.
568:
569: Parameters:
570:
571: =over 4
572:
573: =item $request - Apache Request Object [in] request object for the current
574: request.
575:
576: =item $user - string [in] Name of the user initiating the request.
577:
578: =item $domain - string [in] Domain the initiating user is logged in as
579:
580: =item $filename - string [in] Source filename.
581:
582: =back
583:
584: =cut
585:
586: sub Delete1 {
587: my ($request, $user, $domain, $fn) = @_;
588:
589: if( -e $fn) {
590: $request->print('<input type="hidden" name="newfilename" value="'.
591: $fn.'"/>');
592: if (-d $fn) {
593: unless (&empty_directory($fn,'Delete1')) {
594: $request->print('<h3>'.&mt('Only empty directories may be deleted.').'</h3>'.
595: 'You must delete the contents of the directory first.<br />'.
596: '<br /><a href="'.&url($fn).'">'.&mt('Cancel').'</a>');
597: return;
598: }
599: } else {
600: unless (&obsolete_unpub($user,$domain,$fn)) {
601: $request->print('<h3>'.&mt('Cannot delete non-obsolete published file').'</h3>'.
602: '<br /><a href="'.&url($fn).'">'.&mt('Cancel').'</a>');
603: return;
604: }
605: }
606: $request->print('<p>'.&mt('Delete').' '.&display($fn).'?</p>');
607: &CloseForm1($request, $fn);
608: } else {
609: $request->print('<p>'.&mt('No such file').': '.&display($fn).'</p></form>');
610: }
611: }
612:
613: =pod
614:
615: =item Copy1($request, $user, $domain, $filename, $newfilename)
616:
617: Performs phase 1 processing of the construction space copy command.
618: Ensure that the source file exists. Ensure that a destination exists,
619: also warn if the destination already exists.
620:
621: Parameters:
622:
623: =over 4
624:
625: =item $request - Apache Request Object [in] request object for the current
626: request.
627:
628: =item $user - string [in] Name of the user initiating the request.
629:
630: =item $domain - string [in] Domain the initiating user is logged in as
631:
632: =item $fn - string [in] Source filename.
633:
634: =item $newfilename-string [in] Destination filename.
635:
636: =back
637:
638: =cut
639:
640: sub Copy1 {
641: my ($request, $user, $domain, $fn, $newfilename) = @_;
642:
643: if(-e $fn) {
644: # is dest a dir
645: if (-d $newfilename) {
646: if ($fn =~ m|/([^/]*)$|) { $newfilename .= '/'.$1; }
647: }
648: if ($newfilename =~ m|/[^\.]+$|) {
649: #no extension add on original extension
650: if ($fn =~ m|/[^\.]*\.([^\.]+)$|) { $newfilename.='.'.$1; }
651: }
652: $newfilename=~s://+:/:g; # remove duplicate /
653: while ($newfilename=~m:/\.\./:) {
654: $newfilename=~ s:/[^/]+/\.\./:/:g; #remove dir/..
655: }
656: $request->print(&checksuffix($fn,$newfilename));
657: my ($type,$return)=&exists($user, $domain, $newfilename);
658: $request->print($return);
659: if ($type eq 'error') {
660: $request->print('<br /><a href="'.&url($fn).'">'.&mt('Cancel').'</a>');
661: return;
662: }
663: $request->print('<input type="hidden" name="newfilename" value="'.
664: $newfilename.
665: '" /><p>'.&mt('Copy').' '.&display($fn).'<br />to '.
666: &display($newfilename).'?</p>');
667: &CloseForm1($request, $fn);
668: } else {
669: $request->print('<p>'.&mt('No such file').': '.&display($fn).'</p></form>');
670: }
671: }
672:
673: =pod
674:
675: =item NewDir1
676:
677: Does all phase 1 processing of directory creation:
678: Ensures that the user provides a new directory name,
679: and that the directory does not already exist.
680:
681: Parameters:
682:
683: =over 4
684:
685: =item $request - Apache Request Object [in] - Server request object for the
686: current url.
687:
688: =item $username - Name of the user that is requesting the directory creation.
689:
690: =item $domain - Domain user is in
691:
692: =item $fn - source file.
693:
694: =item $newdir - Name of the directory to be created; path relative to the
695: top level of construction space.
696: =back
697:
698: Side Effects:
699:
700: =over 4
701:
702: =item A new form is displayed. Clicking on the confirmation button
703: causes the newdir operation to transition into phase 2. The hidden field
704: "newfilename" is set with the construction space path to the new directory.
705:
706:
707: =back
708:
709: =cut
710:
711:
712: sub NewDir1 {
713: my ($request, $username, $domain, $fn, $newfilename, $mode) = @_;
714:
715: my ($type, $result)=&exists($username,$domain,$newfilename,'directory');
716: $request->print($result);
717: if ($type eq 'error') {
718: $request->print('</form>');
719: } else {
720: if ($mode eq 'testbank') {
721: $request->print('<input type="hidden" name="callingmode" value="testbank">');
722: } elsif ($mode eq 'imsimport') {
723: $request->print('<input type="hidden" name="callingmode" value="imsimport">');
724: }
725: $request->print('<input type="hidden" name="newfilename" value="'.
726: $newfilename.'" /><p>'.&mt('Make new directory').' '.
727: &display($newfilename).'?</p>');
728: &CloseForm1($request, $fn);
729: }
730: }
731:
732:
733: sub Decompress1 {
734: my ($request, $user, $domain, $fn) = @_;
735: if( -e $fn) {
736: $request->print('<input type="hidden" name="newfilename" value="'.$fn.'"/>');
737: $request->print('<p>'.&mt('Decompress').' '.&display($fn).'?</p>');
738: &CloseForm1($request, $fn);
739: } else {
740: $request->print('<p>'.&mt('No such file').': '.&display($fn).'</p></form>');
741: }
742: }
743:
744: =pod
745:
746: =item NewFile1
747:
748: Does all phase 1 processing of file creation:
749: Ensures that the user provides a new filename, adds proper extension
750: if needed and that the file does not already exist, if it is a html,
751: problem, page, or sequence, it then creates a form link to hand the
752: actual creation off to the proper handler.
753:
754: Parameters:
755:
756: =over 4
757:
758: =item $request - Apache Request Object [in] - Server request object for the
759: current url.
760:
761: =item $username - Name of the user that is requesting the directory creation.
762:
763: =item $domain - Name of the domain of the user
764:
765: =item $fn - Source file name
766:
767: =item $newfilename
768: - Name of the file to be created; no path information
769: =back
770:
771: Side Effects:
772:
773: =over 4
774:
775: =item 2 new forms are displayed. Clicking on the confirmation button
776: causes the browser to attempt to load the specfied URL, allowing the
777: proper handler to take care of file creation. There is also a Cancel
778: button which returns you to the driectory listing you came from
779:
780: =back
781:
782: =cut
783:
784: sub NewFile1 {
785: my ($request, $user, $domain, $fn, $newfilename) = @_;
786:
787: if ($env{'form.action'} =~ /new(.+)file/) {
788: my $extension=$1;
789:
790: ##Informs User (name).(number).(extension) not allowed
791: if($newfilename =~ /\.(\d+)\.(\w+)$/){
792: $r->print('<span class="LC_error">'.$newfilename.
793: ' - '.&mt('Bad Filename').'<br />('.&mt('name').').('.&mt('number').').('.&mt('extension').') '.
794: ' '.&mt('Not Allowed').'</span>');
795: return;
796: }
797: if($newfilename =~ /(\:\:\:|\&\&\&|\_\_\_)/){
798: $r->print('<span class="LC_error">'.$newfilename.
799: ' - '.&mt('Bad Filename').'<br />('.&mt('Must not include').' '.$1.') '.
800: ' '.&mt('Not Allowed').'</span>');
801: return;
802: }
803: if ($newfilename !~ /\Q.$extension\E$/) {
804: if ($newfilename =~ m|/[^/.]*\.(?:[^/.]+)$|) {
805: #already has an extension strip it and add in expected one
806: $newfilename =~ s|(/[^./])\.(?:[^.]+)$|$1|;
807: }
808: $newfilename.=".$extension";
809: }
810: }
811: my ($type, $result)=&exists($user,$domain,$newfilename);
812: $request->print($result);
813: if ($type eq 'error') {
814: $request->print('</form>');
815: } else {
816:
817: $request->print('<p>'.&mt('Make new file').' '.&display($newfilename).'?</p>');
818: $request->print('</form>');
819: $request->print('<form action="'.&url($newfilename).
820: '" method="POST"><p><input type="submit" value="'.&mt('Continue').'" /></p></form>');
821: $request->print('<form action="'.&url($fn).
822: '" method="POST"><p><input type="submit" value="'.&mt('Cancel').'" /></p></form>');
823: }
824: }
825:
826: =pod
827:
828: =item phaseone($r, $fn, $uname, $udom)
829:
830: Peforms phase one processing of the request. In phase one, error messages
831: are returned if the request cannot be performed (e.g. attempts to manipulate
832: files that are nonexistent). If the operation can be performed, what is
833: about to be done will be presented to the user for confirmation. If the
834: user confirms the request, then phase two is executed, the action
835: performed and reported to the user.
836:
837: Parameters:
838:
839: =over 4
840:
841: =item $r - request object [in] - The Apache request being executed.
842:
843: =item $fn = string [in] - The filename being manipulated by the
844: request.
845:
846: =item $uname - string [in] Name of user logged in and doing this action.
847:
848: =item $udom - string [in] Domain name under which the user logged in.
849:
850: =back
851:
852: =cut
853:
854: sub phaseone {
855: my ($r,$fn,$uname,$udom)=@_;
856:
857: my $doingdir=0;
858: if ($env{'form.action'} eq 'newdir') { $doingdir=1; }
859: my $newfilename=&cleanDest($r,$env{'form.newfilename'},$doingdir,$fn,$uname);
860: $newfilename=&relativeDest($fn,$newfilename,$uname);
861: $r->print('<form action="/adm/cfile" method="post">'.
862: '<input type="hidden" name="qualifiedfilename" value="'.$fn.'" />'.
863: '<input type="hidden" name="phase" value="two" />'.
864: '<input type="hidden" name="action" value="'.$env{'form.action'}.'" />');
865:
866: if ($env{'form.action'} eq 'rename') {
867: &Rename1($r, $uname, $udom, $fn, $newfilename, 'rename');
868: } elsif ($env{'form.action'} eq 'move') {
869: &Rename1($r, $uname, $udom, $fn, $newfilename, 'move');
870: } elsif ($env{'form.action'} eq 'delete') {
871: &Delete1($r, $uname, $udom, $fn);
872: } elsif ($env{'form.action'} eq 'decompress') {
873: &Decompress1($r, $uname, $udom, $fn);
874: } elsif ($env{'form.action'} eq 'copy') {
875: if($newfilename) {
876: &Copy1($r, $uname, $udom, $fn, $newfilename);
877: } else {
878: $r->print('<p>'.&mt('No new filename specified.').'</p></form>');
879: }
880: } elsif ($env{'form.action'} eq 'newdir') {
881: my $mode = '';
882: if (exists($env{'form.callingmode'}) ) {
883: $mode = $env{'form.callingmode'};
884: }
885: &NewDir1($r, $uname, $udom, $fn, $newfilename, $mode);
886: } elsif ($env{'form.action'} eq 'newfile' ||
887: $env{'form.action'} eq 'newhtmlfile' ||
888: $env{'form.action'} eq 'newproblemfile' ||
889: $env{'form.action'} eq 'newpagefile' ||
890: $env{'form.action'} eq 'newsequencefile' ||
891: $env{'form.action'} eq 'newrightsfile' ||
892: $env{'form.action'} eq 'newstyfile' ||
893: $env{'form.action'} eq 'newtaskfile' ||
894: $env{'form.action'} eq 'newlibraryfile' ||
895: $env{'form.action'} eq 'Select Action') {
896: my $empty=&mt('Type Name Here');
897: if (($newfilename!~/\/$/) && ($newfilename!~/$empty$/)) {
898: &NewFile1($r, $uname, $udom, $fn, $newfilename);
899: } else {
900: $r->print('<p>'.&mt('No new filename specified.').'</p></form>');
901: }
902: }
903: }
904:
905: =pod
906:
907: =item Rename2($request, $user, $directory, $oldfile, $newfile)
908:
909: Performs phase 2 processing of a rename reequest. This is where the
910: actual rename is performed.
911:
912: Parameters
913:
914: =over 4
915:
916: =item $request - Apache request object [in] The request being processed.
917:
918: =item $user - string [in] The name of the user initiating the request.
919:
920: =item $directory - string [in] The name of the directory relative to the
921: construction space top level of the renamed file.
922:
923: =item $oldfile - Name of the file.
924:
925: =item $newfile - Name of the new file.
926:
927: =back
928:
929: Returns:
930:
931: =over 4
932:
933: =item 1 Success.
934:
935: =item 0 Failure.
936:
937: =cut
938:
939: sub Rename2 {
940:
941: my ($request, $user, $directory, $oldfile, $newfile) = @_;
942:
943: &Debug($request, "Rename2 directory: ".$directory." old file: ".$oldfile.
944: " new file ".$newfile."\n");
945: &Debug($request, "Target is: ".$directory.'/'.
946: $newfile);
947: if (-e $oldfile) {
948:
949: my $oRN=$oldfile;
950: my $nRN=$newfile;
951: unless (rename($oldfile,$newfile)) {
952: $request->print('<span class="LC_error">'.&mt('Error').': '.$!.'</span>');
953: return 0;
954: }
955: ## If old name.(extension) exits, move under new name.
956: ## If it doesn't exist and a new.(extension) exists
957: ## delete it (only concern when renaming over files)
958: my $tmp1=$oRN.'.meta';
959: my $tmp2=$nRN.'.meta';
960: if(-e $tmp1){
961: unless(rename($tmp1,$tmp2)){ }
962: } elsif(-e $tmp2){
963: unlink $tmp2;
964: }
965: $tmp1=$oRN.'.save';
966: $tmp2=$nRN.'.save';
967: if(-e $tmp1){
968: unless(rename($tmp1,$tmp2)){ }
969: } elsif(-e $tmp2){
970: unlink $tmp2;
971: }
972: $tmp1=$oRN.'.log';
973: $tmp2=$nRN.'.log';
974: if(-e $tmp1){
975: unless(rename($tmp1,$tmp2)){ }
976: } elsif(-e $tmp2){
977: unlink $tmp2;
978: }
979: $tmp1=$oRN.'.bak';
980: $tmp2=$nRN.'.bak';
981: if(-e $tmp1){
982: unless(rename($tmp1,$tmp2)){ }
983: } elsif(-e $tmp2){
984: unlink $tmp2;
985: }
986: } else {
987: $request->print("<p> ".&mt('No such file').": ".&display($oldfile).'</p></form>');
988: return 0;
989: }
990: return 1;
991: }
992:
993: =pod
994:
995: =item Delete2($request, $user, $filename)
996:
997: Performs phase two of a delete. The user has confirmed that they want
998: to delete the selected file. The file is deleted and the results of the
999: delete attempt are indicated.
1000:
1001: Parameters:
1002:
1003: =over 4
1004:
1005: =item $request - Apache Request object [in] the request object for the current
1006: delete operation.
1007:
1008: =item $user - string [in] The name of the user initiating the delete
1009: request.
1010:
1011: =item $filename - string [in] The name of the file, relative to construction
1012: space, to delete.
1013:
1014: =back
1015:
1016: Returns:
1017: 1 - success.
1018: 0 - Failure.
1019:
1020: =cut
1021:
1022: sub Delete2 {
1023: my ($request, $user, $filename) = @_;
1024: if (-d $filename) {
1025: unless (&empty_directory($filename,'Delete2')) {
1026: $request->print('<span class="LC_error">'.&mt('Error: Directory Non Empty').'</span>');
1027: return 0;
1028: } else {
1029: if(-e $filename) {
1030: unless(rmdir($filename)) {
1031: $request->print('<span class="LC_error">'.&mt('Error').': '.$!.'</span>');
1032: return 0;
1033: }
1034: } else {
1035: $request->print('<p> '.&mt('No such file').'. </p></form>');
1036: return 0;
1037: }
1038: }
1039: } else {
1040: if(-e $filename) {
1041: unless(unlink($filename)) {
1042: $request->print('<span class="LC_error">'.&mt('Error').': '.$!.'</span>');
1043: return 0;
1044: }
1045: } else {
1046: $request->print('<p> '.&mt('No such file').'. </p></form>');
1047: return 0;
1048: }
1049: }
1050: return 1;
1051: }
1052:
1053: =pod
1054:
1055: =item Copy2($request, $username, $dir, $oldfile, $newfile)
1056:
1057: Performs phase 2 of a copy. The file is copied and the status
1058: of that copy is reported back to the user.
1059:
1060: =over 4
1061:
1062: =item $request - Apache request object [in]; the apache request currently
1063: being executed.
1064:
1065: =item $username - string [in] Name of the user who is requesting the copy.
1066:
1067: =item $dir - string [in] Directory path relative to the construction space
1068: of the destination file.
1069:
1070: =item $oldfile - string [in] Name of the source file.
1071:
1072: =item $newfile - string [in] Name of the destination file.
1073:
1074:
1075: =back
1076:
1077: Returns 0 failure, and 1 successs.
1078:
1079: =cut
1080:
1081: sub Copy2 {
1082: my ($request, $username, $dir, $oldfile, $newfile) = @_;
1083: &Debug($request ,"Will try to copy $oldfile to $newfile");
1084: if(-e $oldfile) {
1085: if ($oldfile eq $newfile) {
1086: $request->print('<span class="LC_error">'.&mt('Warning').': '.&mt('Name of new file is the same as name of old file').' - '.&mt('no action taken').'.</span>');
1087: return 1;
1088: }
1089: unless (copy($oldfile, $newfile)) {
1090: $request->print('<span class="LC_error">'.&mt('copy Error').': '.$!.'</span>');
1091: return 0;
1092: } elsif (!chmod(0660, $newfile)) {
1093: $request->print('<span class="LC_error">'.&mt('chmod error').': '.$!.'</span>');
1094: return 0;
1095: } elsif (-e $oldfile.'.meta' &&
1096: !copy($oldfile.'.meta', $newfile.'.meta') &&
1097: !chmod(0660, $newfile.'.meta')) {
1098: $request->print('<span class="LC_error">'.&mt('copy metadata error').
1099: ': '.$!.'</span>');
1100: return 0;
1101: } else {
1102: return 1;
1103: }
1104: } else {
1105: $request->print('<p> '.&mt('No such file').' </p>');
1106: return 0;
1107: }
1108: return 1;
1109: }
1110:
1111: =pod
1112:
1113: =item NewDir2($request, $user, $newdirectory)
1114:
1115: Performs phase 2 processing of directory creation. This involves creating the directory and
1116: reporting the results of that creation to the user.
1117:
1118: Parameters:
1119: =over 4
1120:
1121: =item $request - Apache request object [in]. Object representing the current HTTP request.
1122:
1123: =item $user - string [in] The name of the user that is initiating the request.
1124:
1125: =item $newdirectory - string [in] The full path of the directory being created.
1126:
1127: =back
1128:
1129: Returns 0 - failure 1 - success.
1130:
1131: =cut
1132:
1133: sub NewDir2 {
1134: my ($request, $user, $newdirectory) = @_;
1135:
1136: unless(mkdir($newdirectory, 02770)) {
1137: $request->print('<span class="LC_error">'.&mt('Error').': '.$!.'</span>');
1138: return 0;
1139: }
1140: unless(chmod(02770, ($newdirectory))) {
1141: $request->print('<span class="LC_error">'.&mt('Error').': '.$!.'</span>');
1142: return 0;
1143: }
1144: return 1;
1145: }
1146:
1147: sub decompress2 {
1148: my ($r, $user, $dir, $file) = @_;
1149: &Apache::lonnet::appenv({'cgi.file' => $file});
1150: &Apache::lonnet::appenv({'cgi.dir' => $dir});
1151: my $result=&Apache::lonnet::ssi_body('/cgi-bin/decompress.pl');
1152: $r->print($result);
1153: &Apache::lonnet::delenv('cgi.file');
1154: &Apache::lonnet::delenv('cgi.dir');
1155: return 1;
1156: }
1157:
1158: =pod
1159:
1160: =item phasetwo($r, $fn, $uname, $udom)
1161:
1162: Controls the phase 2 processing of file management
1163: requests for construction space. In phase one, the user
1164: was asked to confirm the operation. In phase 2, the operation
1165: is performed and the result is shown.
1166:
1167: The strategy is to break out the processing into specific action processors
1168: named action2 where action is the requested action and the 2 denotes
1169: phase 2 processing.
1170:
1171: Parameters:
1172:
1173: =over 4
1174:
1175: =item $r - Apache Request object [in] The request object for this httpd
1176: transaction.
1177:
1178: =item $fn - string [in] A filename indicating the object that is being
1179: manipulated.
1180:
1181: =item $uname - string [in] The name of the user initiating the file management
1182: request.
1183:
1184: =item $udom - string [in] The login domain of the user initiating the
1185: file management request.
1186: =back
1187:
1188: =cut
1189:
1190: sub phasetwo {
1191: my ($r,$fn,$uname,$udom)=@_;
1192:
1193: &Debug($r, "loncfile - Entering phase 2 for $fn");
1194:
1195: # Break down the file into its component pieces.
1196:
1197: my $dir; # Directory path
1198: my $main; # Filename.
1199: my $suffix; # Extension.
1200: if ($fn=~m:(.*)/([^/]+):) {
1201: $dir=$1; # Directory path
1202: $main=$2; # Filename.
1203: }
1204: if($main=~m:\.(\w+)$:){ # Fixes problems with filenames with no extensions
1205: $suffix=$1; #This is the actually filename extension if it exists
1206: $main=~s/\.\w+$//; #strip the extension
1207: }
1208: my $dest; #
1209: my $dest_dir; # On success this is where we'll go.
1210: my $disp_newname; #
1211: my $dest_newname; #
1212: &Debug($r,"loncfile::phase2 dir = $dir main = $main suffix = $suffix");
1213: &Debug($r," newfilename = ".$env{'form.newfilename'});
1214:
1215: my $conspace=$fn;
1216:
1217: &Debug($r,"loncfile::phase2 Full construction space name: $conspace");
1218:
1219: &Debug($r,"loncfie::phase2 action is $env{'form.action'}");
1220:
1221: # Select the appropriate processing sub.
1222: if ($env{'form.action'} eq 'decompress') {
1223: $main .= '.'.$suffix;
1224: if(!&decompress2($r, $uname, $dir, $main)) {
1225: return ;
1226: }
1227: $dest = $dir."/.";
1228: } elsif ($env{'form.action'} eq 'rename' ||
1229: $env{'form.action'} eq 'move') {
1230: if($env{'form.newfilename'}) {
1231: if (!defined($dir)) {
1232: $fn=~m:^(.*)/:;
1233: $dir=$1;
1234: }
1235: if(!&Rename2($r, $uname, $dir, $fn, $env{'form.newfilename'})) {
1236: return;
1237: }
1238: $dest = $dir."/";
1239: $dest_newname = $env{'form.newfilename'};
1240: $env{'form.newfilename'} =~ /.+(\/.+$)/;
1241: $disp_newname = $1;
1242: $disp_newname =~ s/\///;
1243: }
1244: } elsif ($env{'form.action'} eq 'delete') {
1245: if(!&Delete2($r, $uname, $env{'form.newfilename'})) {
1246: return ;
1247: }
1248: # Once a resource is deleted, we just list the directory that
1249: # previously held it.
1250: #
1251: $dest = $dir."/."; # Parent dir.
1252: } elsif ($env{'form.action'} eq 'copy') {
1253: if($env{'form.newfilename'}) {
1254: if(!&Copy2($r, $uname, $dir, $fn, $env{'form.newfilename'})) {
1255: return ;
1256: }
1257: $dest = $env{'form.newfilename'};
1258: } else {
1259: $r->print('<p>'.&mt('No New filename specified').'</p></form>');
1260: return;
1261: }
1262:
1263: } elsif ($env{'form.action'} eq 'newdir') {
1264: my $newdir= $env{'form.newfilename'};
1265: if(!&NewDir2($r, $uname, $newdir)) {
1266: return;
1267: }
1268: $dest = $newdir."/";
1269: }
1270: if ( ($env{'form.action'} eq 'newdir') && ($env{'form.phase'} eq 'two') && ( ($env{'form.callingmode'} eq 'testbank') || ($env{'form.callingmode'} eq 'imsimport') ) ) {
1271: $r->print('<h3><a href="javascript:self.close()">'.&mt('Done').'</a></h3>');
1272: } else {
1273: if ($env{'form.action'} eq 'rename') {
1274: $r->print('<h3><a href="'.&url($dest).'">'.&mt('Return to Directory').'</a></h3>');
1275: $r->print('<h3><a href="'.&url($dest_newname).'">'.$disp_newname.'</a></h3>');
1276: } else {
1277: $r->print(&done(&url($dest)));
1278: }
1279: }
1280: }
1281:
1282: sub handler {
1283:
1284: $r=shift;
1285:
1286: &Apache::loncommon::get_unprocessed_cgi($ENV{'QUERY_STRING'},['decompress','action','filename','newfilename']);
1287:
1288: &Debug($r, "loncfile.pm - handler entered");
1289: &Debug($r, " filename: ".$env{'form.filename'});
1290: &Debug($r, " newfilename: ".$env{'form.newfilename'});
1291: #
1292: # Determine the root filename
1293: # This could come in as "filename", which actually is a URL, or
1294: # as "qualifiedfilename", which is indeed a real filename in filesystem
1295: #
1296: my $fn;
1297:
1298: if ($env{'form.filename'}) {
1299: &Debug($r, "test: $env{'form.filename'}");
1300: $fn=&unescape($env{'form.filename'});
1301: $fn=&URLToPath($fn);
1302: } elsif($ENV{'QUERY_STRING'} && $env{'form.phase'} ne 'two') {
1303: #Just hijack the script only the first time around to inject the
1304: #correct information for further processing
1305: $fn=&unescape($env{'form.decompress'});
1306: $fn=&URLToPath($fn);
1307: $env{'form.action'}="decompress";
1308: } elsif ($env{'form.qualifiedfilename'}) {
1309: $fn=$env{'form.qualifiedfilename'};
1310: } else {
1311: &Debug($r, "loncfile::handler - no form.filename");
1312: $r->log_reason($env{'user.name'}.' at '.$env{'user.domain'}.
1313: ' unspecified filename for cfile', $r->filename);
1314: return HTTP_NOT_FOUND;
1315: }
1316:
1317: unless ($fn) {
1318: &Debug($r, "loncfile::handler - doctored url is empty");
1319: $r->log_reason($env{'user.name'}.' at '.$env{'user.domain'}.
1320: ' trying to cfile non-existing file', $r->filename);
1321: return HTTP_NOT_FOUND;
1322: }
1323:
1324: # ----------------------------------------------------------- Start page output
1325: my $uname;
1326: my $udom;
1327:
1328: ($uname,$udom)=
1329: &Apache::loncacc::constructaccess($fn,$r->dir_config('lonDefDomain'));
1330: &Debug($r,
1331: "loncfile::handler constructaccess uname = $uname domain = $udom");
1332: unless (($uname) && ($udom)) {
1333: $r->log_reason($uname.' at '.$udom.
1334: ' trying to manipulate file '.$env{'form.filename'}.
1335: ' ('.$fn.') - not authorized',
1336: $r->filename);
1337: return HTTP_NOT_ACCEPTABLE;
1338: }
1339:
1340:
1341: &Apache::loncommon::content_type($r,'text/html');
1342: $r->send_http_header;
1343:
1344: my (%loaditem,$js);
1345:
1346: if ( ($env{'form.action'} eq 'newdir') && ($env{'form.phase'} eq 'two') && ( ($env{'form.callingmode'} eq 'testbank') || ($env{'form.callingmode'} eq 'imsimport') ) ) {
1347: my $newdirname = $env{'form.newfilename'};
1348: $js = qq|
1349: <script type="text/javascript">
1350: function writeDone() {
1351: window.focus();
1352: opener.document.info.newdir.value = "$newdirname";
1353: setTimeout("self.close()",10000);
1354: }
1355: </script>
1356: |;
1357: $loaditem{'onload'} = "writeDone()";
1358: }
1359:
1360: $r->print(&Apache::loncommon::start_page('Construction Space File Operation',
1361: $js,
1362: {'add_entries' => \%loaditem,}));
1363:
1364: $r->print('<h3>'.&mt('Location').': '.&display($fn).'</h3>');
1365:
1366: if (($uname ne $env{'user.name'}) || ($udom ne $env{'user.domain'})) {
1367: $r->print('<h3><span class="LC_error">'.&mt('Co-Author').': '.$uname.' at '.$udom.
1368: '</span></h3>');
1369: }
1370:
1371:
1372: &Debug($r, "loncfile::handler Form action is $env{'form.action'} ");
1373: if ($env{'form.action'} eq 'delete') {
1374: $r->print('<h3>'.&mt('Delete').'</h3>');
1375: } elsif ($env{'form.action'} eq 'rename') {
1376: $r->print('<h3>'.&mt('Rename').'</h3>');
1377: } elsif ($env{'form.action'} eq 'move') {
1378: $r->print('<h3>'.&mt('Move').'</h3>');
1379: } elsif ($env{'form.action'} eq 'newdir') {
1380: $r->print('<h3>'.&mt('New Directory').'</h3>');
1381: } elsif ($env{'form.action'} eq 'decompress') {
1382: $r->print('<h3>'.&mt('Decompress').'</h3>');
1383: } elsif ($env{'form.action'} eq 'copy') {
1384: $r->print('<h3>'.&mt('Copy').'</h3>');
1385: } elsif ($env{'form.action'} eq 'newfile' ||
1386: $env{'form.action'} eq 'newhtmlfile' ||
1387: $env{'form.action'} eq 'newproblemfile' ||
1388: $env{'form.action'} eq 'newpagefile' ||
1389: $env{'form.action'} eq 'newsequencefile' ||
1390: $env{'form.action'} eq 'newrightsfile' ||
1391: $env{'form.action'} eq 'newstyfile' ||
1392: $env{'form.action'} eq 'newtaskfile' ||
1393: $env{'form.action'} eq 'newlibraryfile' ||
1394: $env{'form.action'} eq 'Select Action' ) {
1395: $r->print('<h3>'.&mt('New Resource').'</h3>');
1396: } else {
1397: $r->print('<p>'.&mt('Unknown Action').' '.$env{'form.action'}.' </p>'.
1398: &Apache::loncommon::end_page());
1399: return OK;
1400: }
1401: if ($env{'form.phase'} eq 'two') {
1402: &Debug($r, "loncfile::handler entering phase2");
1403: &phasetwo($r,$fn,$uname,$udom);
1404: } else {
1405: &Debug($r, "loncfile::handler entering phase1");
1406: &phaseone($r,$fn,$uname,$udom);
1407: }
1408:
1409: $r->print(&Apache::loncommon::end_page());
1410: return OK;
1411: }
1412:
1413: 1;
1414: __END__
1415:
FreeBSD-CVSweb <freebsd-cvsweb@FreeBSD.org>
![[BACK]](/icons/back.gif){kind=icon}
Return to loncfile.pm CVS log ![[TXT]](/icons/text.gif){kind=icon}
![[DIR]](/icons/dir.gif){kind=icon}
Up to [LON-CAPA] / loncom / publisher