Apache::FileManager - apache mod_perl file manager
- Install in mod_perl enabled apache conf file <Location /FileManager> SetHandler perl-script PerlHandler Apache::FileManager </Location>
- Or call from your own mod_perl script use Apache::FileManager; my $obj = Apache::FileManager->new(); $obj->print();
- Or create your own custom MyFileManager subclass package MyFileManager; use strict; use Apache::FileManager;
our @ISA = ('Apache::FileManager');
sub handler { my $r = shift; my $obj = __PACKAGE__->new(); $r->send_http_header('text/html'); print "<HTML><HEAD><TITLE>".$r->server->server_hostname." File Manager</TITLE> </HEAD>"; $obj->print(); print "</HTML>"; }
.. overload the methods ..
The Apache::FileManager module is a simple HTML file manager. It provides file manipulations such as cut, copy, paste, delete, rename, extract archive, create directory, and upload files. The interface is clean and simple, and configuration is a breeze.
For those of you who are up to the challenge, you can configure Apache::FileManager on run on a development server and update your live server htdocs tree with the click on a button.
The following (non-core) perl modules must be installed before installing Apache::FileManager. Apache::Request => 1.00 Apache::File => 1.01 File::NCopy => 0.32 File::Remove => 0.20 Archive::Any => 0.03 CGI::Cookie => 1.20
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 tarballs and zips.
To use the rync functionality you must have ssh, rsync, and the 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 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 Apache::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 = Apache::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.
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 Apache::FileManager PerlSetVar DOCUMENT_ROOT /web/project/htdocs/newroot </Location>
- Or specify different document root in your own mod_perl script use Apache::FileManager; my $obj = Apache::FileManager->new({ DOCUMENT_ROOT => '/web/project/htdocs/newroot' }); $obj->print();
Create a new file with the following code:
package MyProject::MyFileManager; use strict; use Apache::FileManager; our @ISA = ('Apache::FileManager');
#Add your own methods here
1;
The best way to subclass the filemanager would be to copy the methods you want to overload from the Apache::FileManager file to your new subclass. Then change the methods to your liking. If you think you have a great extension, or you feel like you did something better, email me your subclass and I'll merge the relevant parts to the main code.
I need to write documentation on the different methods. Maybe someone else wants to do this.
There is a bug in File::NCopy that occurs when trying to paste an empty directory. The directory is copied but reports back as 0 directories pasted. The author is in the process of fixing the problem.
Apache::FileManager was written by Philip Collins <pmc@cpan.org>.
To install Apache::FileManager, copy and paste the appropriate command in to your terminal.
cpanm
cpanm Apache::FileManager
CPAN shell
perl -MCPAN -e shell install Apache::FileManager
For more information on module installation, please visit the detailed CPAN module installation guide.