#!/usr/bin/perl
#Copyright (c) 2009, Zane C. Bowers
#All rights reserved.
#
#Redistribution and use in source and binary forms, with or without modification,
#are permitted provided that the following conditions are met:
#
#   * Redistributions of source code must retain the above copyright notice,
#    this list of conditions and the following disclaimer.
#   * Redistributions in binary form must reproduce the above copyright notice,
#    this list of conditions and the following disclaimer in the documentation
#    and/or other materials provided with the distribution.
#
#THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
#ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED 
#WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
#IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT,
#INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, 
#BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, 
#DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
#LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
#OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF
#THE POSSIBILITY OF SUCH DAMAGE.

use strict;
use warnings;
use Getopt::Std;
use Plugtools;

$Getopt::Std::STANDARD_HELP_VERSION = 1;

#version function
sub main::VERSION_MESSAGE {
        print "plurm 0.0.0\n";
}

#print help
sub main::HELP_MESSAGE {
        print "\n".
		      "-u <user>  - The user to remove.\n".
			  "-H <removeHome>  - A boolean value that specifies if the home directory for the user should be removed.\n".
			  "-G <removeGroup>  - A boolean value that specifies if the primary group should be removed if empty.\n".
			  "\n".
			  "removeHome:\n".
			  "The default value for this is false, '0'.\n".
			  "\n".
			  "removeGroup:\n".
			  "The default value for this is truem, '1'.\n".
			  "\n".
			  "For more info, see the the perldocs for Plugtools and plurm...\n".
			  "perldoc plurm\n".
			  "perldoc Plugtools\n";
}

#gets the options
my %opts=();
getopts('u:G:H:', \%opts);

if (!defined($opts{u})) {
	warn('plgrm:254: No user name specified');
	exit 254;
}

my $pt=Plugtools->new;
if ($pt->{error}) {
	warn('plgrm: Failed to initialize the Plugtools object');
	exit $pt->{error};
}

$pt->deleteUser({
				 user=>$opts{u},
				 removeHome=>$opts{H},
				 removeGroup=>$opts{G},
				 });
if ($pt->{error}) {
	warn('plgrm: Failed to remove the group');
	exit $pt->{error};
}

exit 0;

=head1 NAME

plurm - Remove a user from LDAP.

=head1 SYNOPSIS

plurm B<-u> <user> [B<-H> (0|1)] [B<-G> (0|1)]

=head1 SWITCHES

=head2 -u <user>

This specifies the user to remove.

=head2 -H (0|1)

This allows the default or config specified value for if the home
directory should be remove or not.

=head2 -G (0|1)

This allows the default or config specified value for if the primary
group should be remove or not if it is empty.

=head1 EXIT CODES

If the exit code is not listed below, it is what was the error code returned by Plugtools.

=head2 254

No user specified.

=head1 AUTHOR

Copyright (c) 2009, Zame C. Bowers <vvelox@vvelox.net>

All rights reserved.

Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions are met:

    * Redistributions of source code must retain the above copyright notice,
     this list of conditions and the following disclaimer.
    * Redistributions in binary form must reproduce the above copyright
     notice, this list of conditions and the following disclaimer in the
     documentation and/or other materials provided with the distribution.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE
xFOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS` OR
SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

=head1 SCRIPT CATEGORIES

UNIX : System_administration

=head1 OSNAMES

any

=head2 SEE ALSO

Plugtools

=head1 README

plurm - Remove a user from LDAP.

=cut
