######################################################################
#
# EPrints::Platform
#
######################################################################
#
#  This file is part of GNU EPrints 3.
#  
#  Copyright (c) 2000-2007 University of Southampton, UK. SO17 1BJ.
#  
#  EPrints 3 is free software; you can redistribute it and/or modify
#  it under the terms of the GNU General Public License as published by
#  the Free Software Foundation; either version 2 of the License, or
#  (at your option) any later version.
#  
#  EPrints 3 is distributed in the hope that it will be useful,
#  but WITHOUT ANY WARRANTY; without even the implied warranty of
#  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
#  GNU General Public License for more details.
#  
#  You should have received a copy of the GNU General Public License
#  along with EPrints 3; if not, write to the Free Software
#  Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
#
######################################################################


=pod

=head1 NAME

B<EPrints::Platform> - handles platform specific code.

=head1 DESCRIPTION

When you call a method in this class, it is sent to the appropriate
EPrints::Platform::xxx module. Usually this is 
EPrints::Platform::Unix

Which module is used is configured by the {platform} setting in
SystemSettings.pm

All file and directory names are absolute and joined by the Unix
file separator character '/'.

=over 4

=cut

package EPrints::Platform;

use EPrints::SystemSettings;
use strict;
no strict 'refs';

my $platform = $EPrints::SystemSettings::conf->{platform};
my $real_module = "EPrints::Platform::\u$platform";
eval "use $real_module;";

#####################################################################

=item chmod( MODE, @filelist )

Change the access control on files listed in @filelist to MODE.

=cut

#####################################################################

sub chmod { return &{$real_module."::chmod"}( @_ ); }

#####################################################################

=item chown( $uid, $gid, @filelist )

Change the user and group on files listed in @filelist to $uid and
$gid. $uid and $gid are as returned by L<getpwnam> (usually numeric).

=cut

#####################################################################

sub chown { return &{$real_module."::chown"}( @_ ); }

#####################################################################

=item getpwnam( $user )

Return the login-name, password crypt, uid and gid for user $user.

=cut

#####################################################################

sub getpwnam { return &{$real_module."::getpwnam"}( $_[0] ); }

#####################################################################

=item getpwnam( $user )

Return the login-name, password crypt, uid and gid for user $user.

=cut

#####################################################################

sub getgrnam { return &{$real_module."::getgrnam"}( $_[0] ); }

#####################################################################

=item test_uid()

Test whether the current user is the same that is configured in
SystemSettings.

=cut

#####################################################################
 
sub test_uid { return &{$real_module."::test_uid"}( @_ ); }

#####################################################################

=item mkdir( $path, MODE )

Create a directory $path (including parent directories as necessary)
set to mode MODE. If MODE is undefined defaults to dir_perms in
SystemSettings.

=cut

#####################################################################

sub mkdir { return &{$real_module."::mkdir"}( @_ ); }

#####################################################################

=item exec()

Executes certain named tasks, which were once (and may be) handled
by external binaries. This allows a per-platform solution to each
task. (example is unpacking a .tar.gz file).

=cut

#####################################################################
 
sub exec { return &{$real_module."::exec"}( @_ ); }

1;

=back
