#!/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 BIND::SDB::LDAP::Helper;

$Getopt::Std::STANDARD_HELP_VERSION = 1;

#version function
sub main::VERSION_MESSAGE {
        print "pldm-rls 0.0.0\n";
}

#print help
sub main::HELP_MESSAGE {
        print "\n".
		      "-a  Remove the @ entry.\n";
		      "-c <config>  The config file to use.\n".
			  "-d  If a full domain is being printed, append a period.\n".
			  "-f  Print the full hostname.\n".
			  "-z <zone>  The zone to list the relatives for.\n";

		exit 1;
}

#gets the options
my %opts=();
getopts('c:dfz:', \%opts);

#init it
my $pldm=BIND::SDB::LDAP::Helper->new({configfile=>$opts{c}});
if ($pldm->{error}) {
	exit $pldm->{error};
}

#figure out how to join it
my $joinstring="\n";
if ($opts{f}) {
	if ($opts{d}) {
		$joinstring='.'.$opts{z}.".\n";
	}else {
		$joinstring='.'.$opts{z}."\n";
	}
}

#get the list
my @relatives=$pldm->listRelatives($opts{z});
if ($pldm->{error}) {
	exit $pldm->{error};
}

my $relatives=join($joinstring, sort(@relatives)).$joinstring;
#removes @ if desired
if ($opts{a}) {
	$relatives=~s/\@.*\n//;
}

print $relatives;

exit 0;

=head1 NAME

pldm-rls - List the relative domain names for a zone in LDAP.

=head1 SYNOPSIS

pldm-rls [B<-c> <config>] B<-z>

=head1 SWITCHES

=head2 -a

Remove the @.

=head2 -c <config>

The config file to use if the default is not desired.

=head2 -d

If -f is specified add a period on to the end.

=head2 -f

Print the full domain name.

=head2 -z

The zone to list the relative domain names for.

=head1 EXIT CODES

These reflect the error values returned by BIND::SDB::LDAP::Helper.

=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

BIND::SDB::LDAP::Helper

=head1 README

pldm-rls - List relative domain names for a zone in LDAP.

=cut
