Apache2-FileManager
view release on metacpan or search on metacpan
FileManager.pm view on Meta::CPAN
package Apache2::FileManager;
=head1 NAME
Apache2::FileManager - Apache2 mod_perl File Manager
=head1 SYNOPSIS
# Install in mod_perl enabled apache conf file
<Location /FileManager>
SetHandler perl-script
PerlHandler Apache2::FileManager
</Location>
(Then point your browser to http://www.yourwebsite.com/FileManager)
# Or call from your own mod_perl script
use Apache2::FileManager;
my $obj = Apache2::FileManager->new();
$obj->print();
# Or create your own custom MyFileManager subclass
package MyFileManager;
use strict;
use Apache2::FileManager;
our @ISA = ('Apache2::FileManager');
sub handler {
my $r = shift;
my $obj = __PACKAGE__->new();
$r->content_type('text/html');
$r->print ("
<HTML>
<HEAD>
<TITLE>".$r->hostname." File Manager</TITLE>
</HEAD>
");
$obj->print();
$r->print("</HTML>");
}
# .. overload the methods ..
=head1 DESCRIPTION
The Apache2::FileManager module is a simple HTML file manager. It provides
file manipulations such as cut, copy, paste, delete, rename, extract archive,
create directory, create file, edit file, and upload files.
Apache2::FileManager also has the ability to rsync the server htdocs tree to
another server with the click of a button.
=head1 PREREQUISITES
The following (non-core) perl modules must be installed before installing
Apache2::FileManager.
Apache/mod_perl => 2.0
Archive::Any => 0.03
CGI::Cookie => 1.20
File::NCopy => 0.32
File::Remove => 0.20
=head1 SPECIAL NOTES
Make sure the web server has read, write, and execute access access to the
directory you want to manage files in. Typically you are going to want to
run the following commands before you begin.
chown -R nobody /web/xyz/htdocs
chmod -R 755 /web/xyz/htdocs
The extract functionality only works with *.tar.gz and *.zip files.
=head1 RSYNC FEATURE
To use the rync functionality you must have ssh, rsync, and the L<File::Rsync>
perl module installed on the development server. You also must have an sshd
running on the production server.
Make sure you always fully qualify your server names so you don't have
different values in your known hosts file.
For Example:
ssh my-machine - wrong
ssh my-machine.subnet.com - right
Note: If the ip address of the production_server changes you will need to
create a new known_hosts file.
To get the rsync feature to work do the following:
#1 log onto the production server
#2 become root
#3 give web server user (typically nobody) a home area
I made mine /usr/local/apache/nobody
- production_server> mkdir /usr/local/apache/nobody
- edit passwd file and set new home area for nobody
- production_server> mkdir /usr/local/apache/nobody/.ssh
#4 log onto the development server
#5 become root
#6 give web server user (typically nobody) a home area
- dev_server> mkdir /usr/local/apache/nobody
- dev_server> chown -R nobody.nobody /usr/local/apache/nobody
- edit passwd file and set new home area for nobody
- dev_server> su - nobody
- dev_server> ssh-keygen -t dsa (don't use passphrase)
- dev_server> ssh production_server
(will fail but will make known_hosts file)
- log out from user nobody back to root user
- dev_server> cd /usr/local/apache/nobody/.ssh
- dev_server> scp id_dsa.pub production_server:/usr/local/apache/nobody/.ssh/authorized_keys
- dev_server> chown -R nobody.nobody /usr/local/apache/nobody
- dev_server> chmod -R 700 /usr/local/apache/nobody
#7 log back into the production server
#8 become root
#9 Do the following commands:
- production_server> chown -R nobody.nobody /usr/local/apache/nobody
- production_server> chmod -R 700 /usr/local/apache/nobody
You also need to specify the production server in the development server's
web conf file. So your conf file should look like this:
<Location /FileManager>
SetHandler perl-script
PerlHandler Apache2::FileManager
PerlSetVar RSYNC_TO production_server:/web/xyz
</Location>
If your ssh path is not /usr/bin/ssh or /usr/local/bin/ssh, you also need to
specify the path in the conf file or in the contructor with the directive
SSH_PATH.
You can also specify RSYNC_TO in the constructor:
my $obj = Apache2::FileManager->new({
RSYNC_TO => "production_server:/web/xyz"
});
Also make sure /web/xyz and all files in the tree are readable, writeable, and
executable by nobody on both the production server AND the development server.
=head1 USING DIFFERENT DOCUMENT ROOT
You can specify a different document root as long as the new document root
falls inside of the orginal document root. For example if the document root
of a web server is /web/project/htdocs, you could assign the document root to
also be /web/project/htdocs/newroot. The directory `newroot` must exist.
# Specify different document root in apache conf file
<Location /FileManager>
SetHandler perl-script
PerlHandler Apache2::FileManager
PerlSetVar DOCUMENT_ROOT /web/project/htdocs/newroot
</Location>
# Or specify different document root in your own mod_perl script
use Apache2::FileManager;
my $obj = Apache2::FileManager->new({
DOCUMENT_ROOT => '/web/project/htdocs/newroot'
});
$obj->print();
FileManager.pm view on Meta::CPAN
my $o = shift;
r->print(qq{
<CENTER>
<TABLE CELLPADDING=0 CELLSPACING=0 BORDER=0>
<TR><TD>$$o{MESSAGE}</TD></TR>
<TR>
<FORM>
<TD ALIGN=RIGHT>
<INPUT TYPE=BUTTON VALUE='close'
onclick="window.close();">
</TD>
</FORM>
</TR>
</TABLE>
</CENTER>
});
return undef;
}
sub view_filemanager {
my $o = shift;
my ($location, $up_a_href) = $o->html_location_toolbar();
$up_a_href ||= "";
my $message = "<I><FONT COLOR=#990000>".$$o{MESSAGE}."</FONT></I>";
r->print("
<!-- Scripts -->
".$o->html_javascript(r->hostname())."
<!-- Styles -->
".$o->html_style_sheet()."
<FORM NAME=FileManager ACTION='".r->uri."' METHOD=POST>
".$o->html_hidden_fields()."
<!-- Header -->
".$o->html_top()."
<!-- Special message -->
$message
<TABLE CELLPADDING=2 CELLSPACING=2
BORDER=0 WIDTH=100% BGCOLOR=#606060>
<TR><TD>".$o->html_cmd_toolbar()."</TD></TR>
<TR BGCOLOR=WHITE><TD>$location</TD></TR>
<TR><TD>".$o->html_file_list($up_a_href)."</TD></TR>
</TABLE>
<!-- Footer -->
".$o->html_bottom()."
</FORM>
");
return undef;
}
sub view_pre_editfile {
my $o = shift;
my $editfile = r->param('FILEMANAGER_editfile');
my $base = "http://".r->hostname."/$editfile";
$editfile =~ /([^\/]+)$/;
my $filename = $1;
my $fh;
if (-T $filename && -w $filename) {
$fh = IO::File->new("< ".$filename);
}
my $message = "";
if ($$o{MESSAGE}) {
$message =
"<I><FONT COLOR=#990000>".$$o{MESSAGE}."</FONT></I><BR>";
}
if (! $fh) {
r->print("
<HTML>
<HEAD>
<BODY>
<CENTER><BR>$message
<TABLE BORDER=1 CELLPADDING=10 CELLSPACING=0
BGCOLOR=#606060>
<TR BGCOLOR=WHITE>
<TD ALIGN=CENTER>
could not open file: <I>$base</I> in text writing mode
</TD>
</TR>
<TR BGCOLOR=#efefef>
<TD ALIGN=RIGHT>
<FORM>
<INPUT TYPE=BUTTON VALUE=close
onclick=\"
window.close();
return false;\">
</FORM>
</TD>
</TR>
</TABLE>
<BR>
</CENTER>
</BODY>
</HTML>");
}
else {
my $data;
{
local $/=undef;
$data = scalar(<$fh>);
}
r->print("
<SCRIPT>
function show_preview () {
var f = window.document.FileManagerEditFile;
var w = window.open('',
'FileManagerPreviewEditFile',
'scrollbars,resizable,menubar,status,toolbar');
var d = w.document.open();
d.write('<HTML><HEAD><BASE HREF=\"$base\"></HEAD>');
d.write(f.FILEMANAGER_filedata.value);
d.write('</HTML>');
d.close();
w.focus();
}
$$o{JS}
</SCRIPT>
<!-- Styles -->
".$o->html_style_sheet()."
<FORM NAME=FileManagerEditFile
ACTION='".r->uri."'
METHOD=POST>
".$o->html_hidden_fields()."
<INPUT TYPE=HIDDEN NAME=FILEMANAGER_editfile
VALUE=\"".r->param('FILEMANAGER_editfile')."\">
<!-- Header -->
<TABLE WIDTH=100% CELLPADDING=0 CELLSPAING=0>
<TR>
<TD>
<FONT COLOR=#3a3a3a><B>$base</B></FONT>
</TD>
</TR>
</TABLE>
<!-- Special message -->
$message
<TABLE CELLPADDING=2 CELLSPACING=2
BORDER=0 WIDTH=100% BGCOLOR=#606060>
<!-- Toolbar -->
<TR>
<TD ALIGN=CENTER>
<TABLE CELLPADDING=0 CELLSPACING=0
BORDER=0 WIDTH=90%>
<TR ALIGN=CENTER>
<TD ALIGN=CENTER>
<INPUT TYPE=BUTTON VALUE='cancel'
onclick=\"
window.close();
return false;\">
</TD>
<TD ALIGN=CENTER>
<INPUT TYPE=BUTTON VALUE='preview'
onclick=\"
window.show_preview();
return false;\">
</TD>
<TD ALIGN=CENTER>
<INPUT TYPE=BUTTON VALUE='save'
onclick=\"
var f = window.document.FileManagerEditFile;
f.FILEMANAGER_cmd.value = 'savefiledata';
f.submit();
return false;\">
</TD>
</TR>
</TABLE>
</TD>
</TR>
<!-- file edit box -->
<TR>
<TD ALIGN=CENTER BGCOLOR=#efefef>
<TEXTAREA NAME=FILEMANAGER_filedata
COLS=$$o{EDIT_COLS}
ROWS=$$o{EDIT_ROWS}>$data</TEXTAREA>
</TD>
</TR>
<!-- Toolbar -->
<TR>
<TD ALIGN=CENTER>
<TABLE CELLPADDING=0 CELLSPACING=0
BORDER=0 WIDTH=90%>
<TR ALIGN=CENTER>
<TD ALIGN=CENTER>
<INPUT TYPE=BUTTON VALUE='cancel'
onclick=\"
window.close();
return false;\">
</TD>
<TD ALIGN=CENTER>
<INPUT TYPE=BUTTON VALUE='preview'
onclick=\"
window.show_preview();
return false;\">
</TD>
<TD ALIGN=CENTER>
<INPUT TYPE=BUTTON VALUE='save'
onclick=\"
var f = window.document.FileManagerEditFile;
f.FILEMANAGER_cmd.value = 'savefiledata';
f.submit();
return false;\">
</TD>
</TR>
</TABLE>
</TD>
</TR>
</TABLE>
<!-- Footer -->
".$o->html_bottom()."
</FORM>
");
}
return undef;
}
###############################################################################
# ---- HTML Component Output ------------------------------------------------ #
###############################################################################
sub html_javascript {
my $o = shift;
FileManager.pm view on Meta::CPAN
\" <INPUT TYPE=HIDDEN NAME=FILEMANAGER_curr_dir \"+
\" VALUE='".r->param('FILEMANAGER_curr_dir')."'>\");
for (var i=1; i <= 10; i++) {
d.write(\"<INPUT TYPE=FILE SIZE=40 NAME=FILEMANAGER_file\"+i+\"><BR>\");
}
d.write(\"<INPUT TYPE=BUTTON VALUE='cancel' onclick='window.close();'>\"+
\" \"+
\"<INPUT TYPE=SUBMIT NAME=FILEMANAGER_cmd\"+
\" VALUE=upload></CENTER></BODY></HTML>\");
d.close();
w.focus();
}
// make input check box form elements into an array ALL the time
function get_ckbox_array() {
var ar;
sel_files = window.document.FileManager.FILEMANAGER_sel_files;
// no files
if (sel_files == null) {
ar = new Array();
}
// 1 file (no length)
else if (sel_files.length == null) {
ar = [ sel_files ];
}
// more than one file
else {
ar = sel_files;
}
return ar;
}
// make array of check box objects that are selected
function get_sel_ckbox_array() {
var sel_ar = new Array();
var ar = window.get_ckbox_array();
for (var i=0; i < ar.length; i++) {
if (ar[i].checked == true) {
sel_ar.push(ar[i]);
}
}
return sel_ar;
}
// get the number checked
function get_num_checked() {
var sel_ar = get_sel_ckbox_array();
return sel_ar.length;
}
//function to edit file
function edit_file () {
var sel_ar = get_sel_ckbox_array();
//make sure there is 1 and only 1 selected file
if (sel_ar.length != 1) {
window.alert('Please select ONE file to edit by clicking on a '+
'check box with the mouse.');
}
else {
var f= window.document.FileManager;
var cd = escape(f.FILEMANAGER_curr_dir.value);
var editfile = escape(sel_ar[0].value);
var w = window.open('".r->uri."?FILEMANAGER_cmd=editfile".
"&FILEMANAGER_curr_dir='+cd+'".
"&FILEMANAGER_editfile='+editfile,
'FileManagerEditFile',
'scrollbars,resizable');
sel_ar[0].checked = false;
w.focus();
}
}
// make cookie for checked filenames
function save_names (type) {
var cb = get_sel_ckbox_array();
var ac = '';
for (var i=0; i < cb.length; i++) {
ac = ac + cb[i].value + '|';
cb[i].checked = false;
}
if (ac == '') {
window.alert('Please select file(s) by clicking on the '+
'check boxes with the mouse.');
} else {
ac = ac + type;
window.setcookie(cookie_name,ac,1);
}
}
//test if browser cookies are enabled
if (! window.document.cookie ) {
window.setcookie(cookie_name,'test',1);
if (! window.document.cookie) {
document.write('<H1><FONT COLOR=#990000>'+
'please enable cookies</FONT></H1>');
}
window.setcookie(cookie_name,'',-1);
}
$$o{JS}
--></SCRIPT> "; #end return literal
}
sub html_style_sheet {
return "
<STYLE TYPE='text/css'>
<!--
BODY {
background-color: white;
font-family: serif;
margin-top: 0;
margin-right: 0;
margin-bottom: 0;
margin-left: 0;
padding-top: 0;
padding-bottom: 0;
padding-right: 1;
padding-left: 1;
border-top: 0;
border-bottom: 0;
border-right: 0;
border-left: 0;
border-style: 0;
}
FileManager.pm view on Meta::CPAN
for (my $i = 0; $i < $#loc; $i++) {
push @ac, $loc[$i];
my $url = join("/", @ac);
$loc[$i] = "
<A HREF=#
onclick=\"
var f=window.document.FileManager;
f.FILEMANAGER_curr_dir.value='$url';
f.submit();
return false;\">
<FONT COLOR=#006699 SIZE=+1><B>".$loc[$i]."</B></FONT></A>
";
if ($i == ($#loc - 1)) {
$up_a_href = "
<A HREF=#
onclick=\"
var f=window.document.FileManager;
f.FILEMANAGER_curr_dir.value='$url';
f.submit();
return false;\">
<FONT COLOR=#006699 SIZE=+1><B>..</B></FONT></A>
";
}
}
$loc[$#loc] = "<FONT SIZE=+1><B>".$loc[$#loc]."</B></FONT>";
my $location = "
<B>location: </B>
<A HREF=#
onclick=\"
var f=window.document.FileManager;
f.FILEMANAGER_curr_dir.value='';
f.submit();
return false;\">
<FONT COLOR=#006699 SIZE=+1><B>/</B></FONT></A>
".join(" <FONT SIZE=+1><B>/</B></FONT> ", @loc);
return ($location, $up_a_href);
}
sub html_cmd_toolbar {
my $o = shift;
my @cmds = (
#Refresh
"<A HREF=# onclick=\"
var f=window.document.FileManager;
f.submit();
return false;\"
><FONT COLOR=WHITE><B>refresh</B></FONT></A>",
#Edit
"<A HREF=# onclick=\"
window.edit_file(); return false;\"
><FONT COLOR=WHITE><B>edit</B></FONT></A>",
#Cut
"<A HREF=# onclick=\"
window.save_names('cut'); return false;\"
><FONT COLOR=WHITE><B>cut</B></FONT></A>",
#Copy
"<A HREF=# onclick=\"
window.save_names('copy'); return false;\"
><FONT COLOR=WHITE><B>copy</B></FONT></A>",
#Paste
"<A HREF=# onclick=\"
if (window.getcookie(cookie_name) != '') {
var f=window.document.FileManager;
f.FILEMANAGER_cmd.value='paste'; f.submit();
} else {
window.alert('Please select file(s) to paste by checking '+
'the file(s) first and clicking copy or cut.');
}
return false;\"
><FONT COLOR=WHITE><B>paste</B></FONT></A>",
#Delete
"<A HREF=# onclick=\"
var f=window.document.FileManager;
if (get_num_checked() == 0) {
window.alert('Please select a file to delete by clicking'+
' on a check box with the mouse.');
} else {
var msg = '\\n Are you sure?\\n' +
'\\n' + 'Click OK to delete selected ' +
'files & directories\\n' +
' ***including*** files in those directories';
if (window.confirm(msg)) {
f.FILEMANAGER_cmd.value='delete'; f.submit();
}
}
return false; \"
><FONT COLOR=WHITE><B>delete</B></FONT></A>",
#Rename
"<A HREF=# onclick=\"
var f=window.document.FileManager;
if (get_num_checked() != 1) {
window.alert('Please select ONE file to rename by clicking on a '+
'check box with the mouse.');
} else {
var rv=window.prompt('enter new name','');
if ((rv != null) && (rv != '')) {
f.FILEMANAGER_cmd.value='rename';
f.FILEMANAGER_arg.value=rv;
f.submit();
}
}
return false;\"
><FONT COLOR=WHITE><B>rename</B></FONT></A>",
#Extract
"<A HREF=# onclick=\"
var f=window.document.FileManager;
if (get_num_checked() == 0) {
window.alert('Please select a file to extract by clicking on a '+
'check box with the mouse.');
} else {
f.FILEMANAGER_cmd.value='extract';
f.submit();
}
return false;\"
><FONT COLOR=WHITE><B>extract</B></FONT></A>",
#New File
"<A HREF=# onclick=\"
var f=window.document.FileManager;
var rv = window.prompt('new file name','');
var cd = f.FILEMANAGER_curr_dir.value;
if (cd != '') {
rv = cd+'/'+rv;
}
if ((rv != null) && (rv != '')) {
var w = window.open('".r->uri."?FILEMANAGER_cmd=editfile".
"&FILEMANAGER_curr_dir='+escape(cd)+'".
"&FILEMANAGER_editfile='+escape(rv),
'FileManagerEditFile',
'scrollbars,resizable');
w.focus();
} else if (rv == '') {
window.alert('can not create blank file names');
}
return false; \">
<FONT COLOR=WHITE><B>new file</B></FONT></A>",
#New Directory
"<A HREF=# onclick=\"
var f=window.document.FileManager;
var rv=window.prompt('new directory name','');
if ((rv != null) && (rv != '')) {
f.FILEMANAGER_arg.value=rv;
f.FILEMANAGER_cmd.value='mkdir';
f.submit();
} else if (rv == '') {
window.alert('can not create blank directory names');
}
return false;\"
><FONT COLOR=WHITE><B>new directory</B></FONT></A>",
#Upload
"<A HREF=# onclick=\"
window.print_upload();
return false;\"
><FONT COLOR=WHITE><B>upload<B></FONT></A>"
);
#Rsync
my $rsync = "";
if ($$o{'RSYNC_TO'}) {
push @cmds,
"<TD><A HREF=# onclick=\"
if (window.confirm('Are you sure you want to synchronize with ".
"the production server?')) {
var w=window.open('','RSYNC',
'scrollbars=yes,resizables=yes,width=400,height=500');
w.focus();
var d=w.document.open();
d.write('<HTML><BODY><BR><BR><BR>".
"<CENTER>Please wait synchronizing production server.".
"<BR>This could take several minutes.".
"</CENTER></BODY></HTML>');
d.close();
w.location.replace('".r->uri."?FILEMANAGER_cmd=rsync',
'RSYNC',
'scrollbars=yes,resizables=yes,width=400,height=500');
} return false;\"
><FONT COLOR=WHITE><B>synchronize</B></FONT></A>";
}
return "
<!-- Actions Tool bar -->
<TABLE CELLPADDING=0 CELLSPACING=0
BORDER=0>
<TR ALIGN=CENTER>
FileManager.pm view on Meta::CPAN
sub get_selected_files {
my @sel_files = r->param('FILEMANAGER_sel_files');
return \@sel_files;
}
sub filename_esc {
#escape spaces in filename
my $o = shift;
my $f = shift;
$f =~ s/\ /\\\ /g;
return $f;
}
sub formated_date {
my $o = shift;
my $date = shift || time;
return strftime "%D %l:%M %P", localtime($date);
}
sub get_clip_board {
my $o = shift;
#get copy and cut file arrays
my $buffer_type = "";
my $buffer_filenames = [];
if (defined(r->headers_in->{'Cookie'})) {
my $cookie_name = uc(r->hostname());
$cookie_name =~ s/[^A-Z]//g;
$cookie_name .= "_FM";
my %cookies = CGI::Cookie->parse(r->headers_in->{'Cookie'});
if (exists $cookies{$cookie_name}) {
my $data = $cookies{$cookie_name}->value;
my @ar = split /\|/, $data;
#is there something in buffer
if ($#ar > 0) {
$buffer_type = pop @ar;
$buffer_filenames = \@ar;
}
}
}
return ($buffer_type, $buffer_filenames);
}
###############################################################################
# -- Commands (called via form input from method execute_cmds or manually) -- #
###############################################################################
sub cmd_savefiledata {
my $o = shift;
my $base = r->param('FILEMANAGER_editfile');
$base =~ /([^\/]+)$/;
my $filename = $1;
remove $filename;
my $fh = IO::File->new("> ".$filename);
print $fh scalar(r->param('FILEMANAGER_filedata'));
$$o{MESSAGE} = "file saved";
$$o{view} = "pre_editfile";
return undef;
}
sub cmd_editfile {
my $o = shift;
my $base = r->param('FILEMANAGER_editfile');
$base =~ /([^\/]+)$/;
my $filename = $1;
if (! -e $filename) {
my $fh = IO::File->new("> ".$filename);
if ($fh) {
$$o{JS} .= "
if (window.opener && window.opener.document.FileManager) {
window.opener.document.FileManager.submit();
}";
}
}
$$o{view} = "pre_editfile";
}
sub cmd_paste {
my $o = shift;
my $arg1 = shift;
my ($buffer_type, $files) = $o->get_clip_board();
my $count = 0;
if ($buffer_type eq "copy") {
my @files = map { $o->filename_esc($$o{DR}."/".$_) } @{ $files };
$count = copy \1, @files, ".";
} elsif ($buffer_type eq "cut") {
for (@{ $files }) {
my $file = $$o{DR}."/".$_;
if (-d $file) {
my $file = $o->filename_esc($file);
my $tmp = copy \1, $file, ".";
if ($tmp) {
remove \1, $file and $count++;
}
} elsif (-f $file) {
move($file, ".") and $count++;
}
}
}
if ($count == 0) {
$$o{MESSAGE} = "0 files and directories pasted";
} elsif ($count == 1) {
$$o{MESSAGE} = "1 file or directory pasted";
} else {
$$o{MESSAGE} = "$count files or directories pasted";
}
$$o{JS} = "window.setcookie(cookie_name,'',-1);";
return undef;
}
sub cmd_delete {
my $o = shift;
my $arg1 = shift;
my $sel_files = $o->get_selected_files();
my @files = map { $o->filename_esc($$o{DR}."/".$_) } @{ $sel_files };
my $count = remove \1, @files;
if ($count == 0) {
$$o{MESSAGE} = "0 files and directories deleted";
} elsif ($count == 1) {
$$o{MESSAGE} = "1 file or directory deleted";
} else {
$$o{MESSAGE} = "$count files or directories deleted";
}
return undef;
}
sub cmd_extract {
my $o = shift;
my $arg1 = shift;
( run in 2.680 seconds using v1.01-cache-2.11-cpan-13bb782fe5a )