diff options
Diffstat (limited to 'lib/uri/ldap.rb')
| -rw-r--r-- | lib/uri/ldap.rb | 89 |
1 files changed, 80 insertions, 9 deletions
diff --git a/lib/uri/ldap.rb b/lib/uri/ldap.rb index 163d2cda24..4544349f18 100644 --- a/lib/uri/ldap.rb +++ b/lib/uri/ldap.rb @@ -1,27 +1,31 @@ -# +# frozen_string_literal: false # = uri/ldap.rb # -# Author:: +# Author:: # Takaaki Tateishi <ttate@jaist.ac.jp> # Akira Yamada <akira@ruby-lang.org> -# License:: +# License:: # URI::LDAP is copyrighted free software by Takaaki Tateishi and Akira Yamada. # You can redistribute it and/or modify it under the same term as Ruby. -# Revision:: $Id$ +# +# See URI for general documentation # -require 'uri/generic' +require_relative 'generic' module URI # - # LDAP URI SCHEMA (described in RFC2255) + # LDAP URI SCHEMA (described in RFC2255). + #-- # ldap://<host>/<dn>[?<attrs>[?<scope>[?<filter>[?<extensions>]]]] - # + #++ class LDAP < Generic + # A Default port of 389 for URI::LDAP. DEFAULT_PORT = 389 - + + # An Array of the available components for URI::LDAP. COMPONENT = [ :scheme, :host, :port, @@ -32,12 +36,41 @@ module URI :extensions, ].freeze + # Scopes available for the starting point. + # + # * SCOPE_BASE - the Base DN + # * SCOPE_ONE - one level under the Base DN, not including the base DN and + # not including any entries under this + # * SCOPE_SUB - subtrees, all entries at all levels + # SCOPE = [ SCOPE_ONE = 'one', SCOPE_SUB = 'sub', SCOPE_BASE = 'base', ].freeze + # + # == Description + # + # Creates a new URI::LDAP object from components, with syntax checking. + # + # The components accepted are host, port, dn, attributes, + # scope, filter, and extensions. + # + # The components should be provided either as an Array, or as a Hash + # with keys formed by preceding the component names with a colon. + # + # If an Array is used, the components must be passed in the + # order <code>[host, port, dn, attributes, scope, filter, extensions]</code>. + # + # Example: + # + # uri = URI::LDAP.build({:host => 'ldap.example.com', + # :dn => '/dc=example'}) + # + # uri = URI::LDAP.build(["ldap.example.com", nil, + # "/dc=example;dc=com", "query", nil, nil, nil]) + # def self.build(args) tmp = Util::make_components_hash(self, args) @@ -56,6 +89,22 @@ module URI return super(tmp) end + # + # == Description + # + # Creates a new URI::LDAP object from generic URI components as per + # RFC 2396. No LDAP-specific syntax checking is performed. + # + # Arguments are +scheme+, +userinfo+, +host+, +port+, +registry+, +path+, + # +opaque+, +query+, and +fragment+, in that order. + # + # Example: + # + # uri = URI::LDAP.new("ldap", nil, "ldap.example.com", nil, nil, + # "/dc=example;dc=com", nil, "query", nil) + # + # See also URI::Generic.new. + # def initialize(*arg) super(*arg) @@ -67,11 +116,15 @@ module URI parse_query end + # Private method to cleanup +dn+ from using the +path+ component attribute. def parse_dn + raise InvalidURIError, 'bad LDAP URL' unless @path @dn = @path[1..-1] end private :parse_dn + # Private method to cleanup +attributes+, +scope+, +filter+, and +extensions+ + # from using the +query+ component attribute. def parse_query @attributes = nil @scope = nil @@ -89,6 +142,7 @@ module URI end private :parse_query + # Private method to assemble +query+ from +attributes+, +scope+, +filter+, and +extensions+. def build_path_query @path = '/' + @dn @@ -101,10 +155,12 @@ module URI end private :build_path_query + # Returns dn. def dn @dn end + # Private setter for dn +val+. def set_dn(val) @dn = val build_path_query @@ -112,15 +168,18 @@ module URI end protected :set_dn + # Setter for dn +val+. def dn=(val) set_dn(val) val end + # Returns attributes. def attributes @attributes end + # Private setter for attributes +val+. def set_attributes(val) @attributes = val build_path_query @@ -128,15 +187,18 @@ module URI end protected :set_attributes + # Setter for attributes +val+. def attributes=(val) set_attributes(val) val end + # Returns scope. def scope @scope end + # Private setter for scope +val+. def set_scope(val) @scope = val build_path_query @@ -144,15 +206,18 @@ module URI end protected :set_scope + # Setter for scope +val+. def scope=(val) set_scope(val) val end + # Returns filter. def filter @filter end + # Private setter for filter +val+. def set_filter(val) @filter = val build_path_query @@ -160,15 +225,18 @@ module URI end protected :set_filter + # Setter for filter +val+. def filter=(val) set_filter(val) val end + # Returns extensions. def extensions @extensions end + # Private setter for extensions +val+. def set_extensions(val) @extensions = val build_path_query @@ -176,15 +244,18 @@ module URI end protected :set_extensions + # Setter for extensions +val+. def extensions=(val) set_extensions(val) val end + # Checks if URI has a path. + # For URI::LDAP this will return +false+. def hierarchical? false end end - @@schemes['LDAP'] = LDAP + register_scheme 'LDAP', LDAP end |