Gavin Henry > Samba-LDAP > Samba::LDAP::Config

Download:
Samba-LDAP-0.05.tar.gz

Dependencies

Annotate this POD

CPAN RT

Open  0
View/Report Bugs
Module Version: 0.05   Source  

NAME ^

Samba::LDAP::Config - Config file related tasks for Samba::LDAP

VERSION ^

This document describes Samba::LDAP::Config version 0.05

SYNOPSIS ^

    use Samba::LDAP::Config;

    my $config = Samba::LDAP::Config->new()
        or die "Can't create object\n";
    
    # Returns where smbldap.conf, smbldap_bind.conf and
    # smb.conf are located
    my $smbldap_conf = $config->find_smbldap();    
    my $smbldap_bind_conf = $config->find_smbldap_bind();
    my $samba_conf = $config->find_samba();

DESCRIPTION ^

Various methods to find where the related Samba configuration files are saved, read them in and write them out etc. Subclasses Config::Tiny

DEVELOPER RELEASE!

BE WARNED - Not yet complete and neither are the docs!

INTERFACE ^

new

Create a new Samba::LDAP::Config object

find_smbldap

Searches in usual places for smbldap.conf and returns location found.

    my $smbldap_conf = $config->find_smbldap();

Returns the smbldap.conf in the scripts, if nothing found.

find_smbldap_bind

Searches in usual places for smbldap_bind.conf and returns location found.

    my $smbldap_bind_conf = $config->find_smbldap_bind();

Returns the smbldap_bind.conf in the scripts, if nothing found.

find_samba

Searches in usual places for smb.conf and returns location found.

    my $smb_conf = $config->find_samba();

Returns the smb.conf in the scripts, if nothing found.

read_conf

Wrapper to provide an instant error message as returned by the native Config::Tiny read method

    my $conf = $config->read_conf( $filename );

read_string

Overrides Config::Tiny's read_string to exclude the " " marks found in smbldap.conf and smbldap_bind.conf and remove section handling, as we don't have any [sections] in either of these files.

Also substitutes the suffix hash ( ${suffix} ) with its value.

Need to fix the smb.conf reading. Will use File::Samba or Config::Auto for it instead.

DIAGNOSTICS ^

None yet.

CONFIGURATION AND ENVIRONMENT ^

Samba::LDAP::Config requires no configuration files or environment variables.

DEPENDENCIES ^

Config::Tiny, Regexp::DefaultFlags and Readonly

INCOMPATIBILITIES ^

None reported.

BUGS AND LIMITATIONS ^

No bugs have been reported.

Please report any bugs or feature requests to bug-samba-ldap@rt.cpan.org, or through the web interface at http://rt.cpan.org.

AUTHOR ^

Gavin Henry <ghenry@suretecsystems.com>

ACKNOWLEDGEMENTS ^

IDEALX for original scripts.

LICENCE AND COPYRIGHT ^

Copyright (c) 2001-2002 IDEALX - Original smbldap-tools

Copyright (c) 2006, Suretec Systems Ltd. - Gavin Henry <ghenry@suretecsystems.com>

This program 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. See perlgpl.

DISCLAIMER OF WARRANTY ^

BECAUSE THIS SOFTWARE IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY FOR THE SOFTWARE, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES PROVIDE THE SOFTWARE "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE SOFTWARE IS WITH YOU. SHOULD THE SOFTWARE PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING, REPAIR, OR CORRECTION.

IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR REDISTRIBUTE THE SOFTWARE AS PERMITTED BY THE ABOVE LICENCE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL, OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE USE OR INABILITY TO USE THE SOFTWARE (INCLUDING BUT NOT LIMITED TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD PARTIES OR A FAILURE OF THE SOFTWARE TO OPERATE WITH ANY OTHER SOFTWARE), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES.

syntax highlighting: