Treequel

# File lib/treequel.rb, line 139
def self::directory( *args )
        options = {}

        args.each do |arg|
                case arg
                when String, URI
                        options.merge!( self.make_options_from_uri(arg) )
                when Hash
                        options.merge!( arg )
                else
                        raise ArgumentError, "unknown directory option %p: expected URL or Hash" % [ arg ]
                end
        end

        return Treequel::Directory.new( options )
end

# File lib/treequel.rb, line 161
def self::directory_from_config( configfile=nil )
        configfile ||= self.find_configfile or
                raise ArgumentError, "No configfile specified, and no defaults present."

        # Read options from ENV and the config file
        fileopts    = self.read_opts_from_config( configfile )
        envopts     = self.read_opts_from_environment

        # Now merge all the options together with env > file > default
        options = Treequel::Directory::DEFAULT_OPTIONS.merge( fileopts.merge(envopts) )

        return Treequel::Directory.new( options )
end

# File lib/treequel.rb, line 205
def self::find_configfile
        # LDAPCONF may be set to the path of a configuration file. This path can
        # be absolute or relative to the current working directory.
        if configfile = ENV['LDAPCONF']
                Treequel.log.info "Using LDAPCONF environment variable for path to ldap.conf"
                configpath = Pathname( configfile ).expand_path
                raise "Config file #{configfile}, specified in the LDAPCONF environment variable, " +
                        "does not exist or isn't readable." unless configpath.readable?
                return configpath

        # The LDAPRC, if defined, should be the basename of a file in the current working 
        # directory or in the user's home directory.
        elsif rcname = ENV['LDAPRC']
                Treequel.log.info "Using LDAPRC environment variable for path to ldap.conf"
                rcpath = Pathname( rcname ).expand_path
                return rcpath if rcpath.readable?
                rcpath = Pathname( "~" ).expand_path + rcname
                return rcpath if rcpath.readable?

                raise "Config file '#{rcname}', specified in the LDAPRC environment variable, does not " +
                        "exist or isn't readable."
        else
                Treequel.log.info "Searching common paths for ldap.conf"
                return COMMON_LDAP_CONF_PATHS.collect {|path| Pathname(path) }.
                        find {|path| path.readable? }
        end
end

# File lib/treequel.rb, line 178
def self::make_options_from_uri( uri )
        uri = URI( uri ) unless uri.is_a?( URI )
        raise ArgumentError, "not an LDAP URL: %p" % [ uri ] unless
                uri.scheme =~ %rldaps?/
        options = {}

        # Use either the scheme or the port from the URI to set the port
        if uri.port
                options[:port] = uri.port
        elsif uri.scheme == 'ldaps'
                options[:port] = LDAP::LDAPS_PORT
        end

        # Set the connection type if the scheme dictates it
        options[:connect_type] = :ssl if uri.scheme == 'ldaps'

        options[:host]    = uri.host if uri.host
        options[:base_dn] = uri.dn unless uri.dn.nil? || uri.dn.empty?
        options[:bind_dn] = uri.user if uri.user
        options[:pass]    = uri.password if uri.password

        return options
end

# File lib/treequel.rb, line 236
def self::read_opts_from_config( configfile )
        Treequel.log.info "Reading config options from %s..." % [ configfile ]
        opts = {}

        linecount = 0
        IO.foreach( configfile ) do |line|
                Treequel.log.debug "  line: %p" % [ line ]
                linecount += 1
                case line

                # URI <ldap[si]://[name[:port]] ...>
                # :TODO: Support multiple URIs somehow?
                when %r^\s*URI\s+(\S+)/
                        Treequel.log.debug "  setting options from a URI: %p" % [ line ]
                        uriopts = self.make_options_from_uri( $1 )
                        opts.merge!( uriopts )

                # BASE <base>
                when %r^\s*BASE\s+(\S+)/
                        Treequel.log.debug "  setting default base DN: %p" % [ line ]
                        opts[:base_dn] = $1

                # BINDDN <dn>
                when %r^\s*BINDDN\s+(\S+)/
                        Treequel.log.debug "  setting bind DN: %p" % [ line ]
                        opts[:bind_dn] = $1

                # bindpw <bindpw> (ldap_nss only)
                when %r^\s*bindpw\s+(\S+)/
                        Treequel.log.debug "  setting bind password from line %s" % [ linecount ]
                        opts[:pass] = $1

                # HOST <name[:port] ...>
                when %r^\s*HOST\s+(\S+)/
                        Treequel.log.debug "  setting host: %p" % [ line ]
                        opts[:host] = $1

                # PORT <port>
                when %r^\s*PORT\s+(\S+)/
                        Treequel.log.debug "  setting port: %p" % [ line ]
                        opts[:port] = $1.to_i

                # SSL <on|off|start_tls>
                when %r^\s*SSL\s+(\S+)/
                        mode = $1.downcase
                        case mode
                        when 'on'
                                Treequel.log.debug "  enabling plain SSL: %p" % [ line ]
                                opts[:port] = 636
                                opts[:connect_type] = :ssl
                        when 'off'
                                Treequel.log.debug "  disabling SSL: %p" % [ line ]
                                opts[:port] = 389
                                opts[:connect_type] = :plain
                        when 'start_tls'
                                Treequel.log.debug "  enabling TLS: %p" % [ line ]
                                opts[:port] = 389
                                opts[:connect_type] = :tls
                        else
                                Treequel.log.error "Unknown 'ssl' setting %p in %s line %d" %
                                        [ mode, configfile, linecount ]
                        end

                end
        end

        return opts
end

# File lib/treequel.rb, line 308
def self::read_opts_from_environment
        opts = {}

        opts.merge!( self.make_options_from_uri(ENV['LDAPURI']) ) if ENV['LDAPURI']
        opts[:host]    = ENV['LDAPHOST']      if ENV['LDAPHOST']
        opts[:port]    = ENV['LDAPPORT'].to_i if ENV['LDAPPORT']
        opts[:bind_dn] = ENV['LDAPBINDDN']    if ENV['LDAPBINDDN']
        opts[:base_dn] = ENV['LDAPBASE']      if ENV['LDAPBASE']

        return opts
end

# File lib/treequel.rb, line 56
def self::version_string( include_buildnum=false )
        vstring = "%s %s" % [ self.name, VERSION ]
        vstring << " (build %s)" % [ REVISION[%r: ([[:xdigit:]]+)/, 1] || '0' ] if include_buildnum
        return vstring
end

# File lib/treequel.rb, line 101
def self::reset_logger
        self.logger = self.default_logger
        self.logger.level = Logger::WARN
        self.logger.formatter = self.default_log_formatter
end

# File lib/treequel.rb, line 110
def self::using_default_logger?
        return self.logger == self.default_logger
end