ruby-activeldap-debug 0.5.7 → 0.5.8

data/lib/activeldap.rb

@@ -899,18 +899,22 @@
 # package, and I'd like to see it prove helpful to more people than just myself.
 #
 
-
+# Blanket warning hiding. Remove for debugging
+$VERBOSE, verbose = false, $VERBOSE
 
 require 'activeldap/base'
 require 'activeldap/associations'
 require 'activeldap/configuration'
 require 'activeldap/schema2'
 
+
 module ActiveLDAP
-  VERSION = "0.5.7"
+  VERSION = "0.5.8"
 end
 
 ActiveLDAP::Base.class_eval do
   include ActiveLDAP::Configuration
   include ActiveLDAP::Associations
 end
+
+$VERBOSE = verbose

data/lib/activeldap/associations.rb

@@ -41,7 +41,11 @@ module ActiveLDAP
 
            # Return the full base of the class
            def base
-             "#{prefix},\#{super}"
+             if "#{prefix}".empty?
+               return "\#{super}"
+             else
+               return "#{prefix},\#{super}"
+             end
            end
 
            # Return the expected DN attribute of an object

data/lib/activeldap/base.rb

@@ -175,6 +175,7 @@ module ActiveLDAP
     # :base overwrites Base.base - this affects EVERYTHING
     # :try_sasl indicates that a SASL bind should be attempted when binding to the server (default: false)
     # :allow_anonymous indicates that a true anonymous bind is allowed when trying to bind to the server (default: true)
+    # :retries - indicates the number of attempts to reconnect that will be undertaken when a stale connection occurs.
     def Base.connect(config={}) # :user, :password_block, :logger
       # Process config
       # Class options
@@ -182,6 +183,7 @@ module ActiveLDAP
       @@config = {}
       @@config[:host] = config[:host] || @@host
       @@config[:port] = config[:port] || @@port
+      @@config[:retries] = config[:retries] || 3
       if config[:base]
         Base.class_eval <<-"end_eval"
           def Base.base
@@ -214,31 +216,8 @@ module ActiveLDAP
       # Setup bind credentials
       @@config[:user] = ENV['USER'] unless @@config[:user]
 
-      # Connect to LDAP
-      begin
-        # SSL using START_TLS
-        @@conn = LDAP::SSLConn.new(@@config[:host], @@config[:port], true)
-      rescue
-        @@logger.warn "Warning: Failed to connect using TLS!"
-        begin
-          @@logger.warn "Warning: Attempting SSL connection . . ."
-          @@conn = LDAP::SSLConn.new(@@config[:host], @@config[:port], false)
-          # HACK: Load the schema here because otherwise you can't tell if the
-          # HACK: SSLConn is a real SSL connection.
-          @@schema = @@conn.schema() if @@schema.nil?
-        rescue
-          @@logger.warn "Warning: Attempting unencrypted connection . . ."
-          @@conn = LDAP::Conn.new(@@config[:host], @@config[:port])
-        end
-      end
-      @@logger.debug "Connected to #{@@config[:host]}:#{@@config[:port]}."
-
-      # Enforce LDAPv3
-      @@conn.set_option(LDAP::LDAP_OPT_PROTOCOL_VERSION, 3)
-
-      # Authenticate
-      do_bind
-
+      do_connect()
+      
       # Load Schema (if not straight SSL...)
       begin
         @@schema = @@conn.schema() if @@schema.nil?
@@ -254,7 +233,11 @@ module ActiveLDAP
     # This method deletes the LDAP connection object.
     # This does NOT reset any overridden values from a Base.connect call.
     def Base.close
-      @@conn.unbind unless @@conn.nil?
+      begin
+        @@conn.unbind unless @@conn.nil?
+      rescue
+        # Doesn't matter.
+      end
       @@conn = nil
       # Make sure it is cleaned up
       ObjectSpace.garbage_collect
@@ -296,6 +279,7 @@ module ActiveLDAP
       values = []
       config[:attrs] = config[:attrs].to_a # just in case
 
+      tries = 0
       begin
         @@conn.search(config[:base], config[:scope], config[:filter], config[:attrs])  do |m|
           res = {}
@@ -308,8 +292,16 @@ module ActiveLDAP
           values.push(res)
         end
       rescue RuntimeError => detail
-        @@logger.debug "No matches for #{config[:filter]} and attrs #{config[:attrs]}"
-        # Do nothing on failure
+        #TODO# Check for 'No message' when retrying
+        # The connection may have gone stale. Let's reconnect and retry. 
+        if tries > @max_retries
+          # Do nothing on failure
+          @@logger.debug "No matches for #{config[:filter]} and attrs #{config[:attrs]}"
+        end
+        tries += 1
+        # Reconnect and rebind.
+        do_connect()
+        retry
       end
       return values
     end
@@ -351,6 +343,7 @@ module ActiveLDAP
 
       matches = []
 
+      tries = 0
       begin
         # Get some attributes
         @@conn.search(base(), LDAP::LDAP_SCOPE_SUBTREE, "(#{attr}=#{val})")  do |m|
@@ -364,8 +357,16 @@ module ActiveLDAP
           end
         end
       rescue RuntimeError => detail
-        @@logger.debug "No matches for #{attr}=#{val}"
-        # Do nothing on failure
+        #todo# check for 'no message' when retrying
+        # the connection may have gone stale. let's reconnect and retry. 
+        if tries > @max_retries
+          # do nothing on failure
+          @@logger.debug "no matches for #{attr}=#{val}"
+        end
+        tries += 1
+        # reconnect and rebind.
+        do_connect()
+        retry
       end
       return nil
     end
@@ -403,6 +404,7 @@ module ActiveLDAP
 
       matches = []
 
+      tries = 0
       begin
         # Get some attributes
         @@conn.search(base(), LDAP::LDAP_SCOPE_SUBTREE, "(#{attr}=#{val})")  do |m|
@@ -416,9 +418,16 @@ module ActiveLDAP
           end
         end
       rescue RuntimeError => detail
-        #p @@conn.err2string(@@conn.err)
-        @@logger.debug "No matches for #{attr}=#{val}"
-        # Do nothing on failure
+        #todo# check for 'no message' when retrying
+        # the connection may have gone stale. let's reconnect and retry. 
+        if tries > @max_retries
+          # do nothing on failure
+          @@logger.debug "no matches for #{attr}=#{val}"
+        end
+        tries += 1
+        # reconnect and rebind.
+        do_connect()
+        retry
       end
       return matches
     end
@@ -499,6 +508,7 @@ module ActiveLDAP
       @data = {} # where the r/w entry data is stored
       @ldap_data = {} # original ldap entry data
       @attr_methods = {} # list of valid method calls for attributes used for dereferencing
+      @last_oc = nil # for use in other methods for "caching"
 
       # Break val apart if it is a dn
       if val.match(/^#{dnattr()}=([^,=]+),#{base()}$/i)
@@ -516,6 +526,7 @@ module ActiveLDAP
         send(:apply_objectclass, required_classes())
       else # do a search then
         # Search for the existing entry
+        tries = 0
         begin
           # Get some attributes
           Base.connection.search("#{dnattr()}=#{val},#{base()}", LDAP::LDAP_SCOPE_SUBTREE, "objectClass=*")  do |m|
@@ -546,7 +557,24 @@ module ActiveLDAP
           @ldap_data.each do |pair|
             send(:attribute_method=, pair[0], pair[1].dup)
           end
-
+				rescue RuntimeError => detail
+					#todo# check for 'no message' when retrying
+					# the connection may have gone stale. let's reconnect and retry. 
+					if tries > @max_retries
+						@exists = false
+						# Create what should be the authoritative DN
+						@dn = "#{dnattr()}=#{val},#{base()}"
+						send(:apply_objectclass, required_classes())
+
+						# Setup dn attribute (later rdn too!)
+						attr_sym = "#{dnattr()}=".to_sym
+						@@logger.debug("new: setting dnattr: #{dnattr()} = #{val}")
+						send(attr_sym, val)
+					end
+					tries += 1
+					# reconnect and rebind.
+					do_connect()
+					retry
         rescue LDAP::ResultError
           @exists = false
           # Create what should be the authoritative DN
@@ -640,9 +668,20 @@ module ActiveLDAP
     # Delete this entry from LDAP
     def delete
       @@logger.debug("stub: delete called")
+      tries = 0
       begin
         @@conn.delete(@dn)
         @exists = false
+			rescue RuntimeError => detail
+				#todo# check for 'no message' when retrying
+				# the connection may have gone stale. let's reconnect and retry. 
+				if tries > @max_retries
+          raise DeleteError, "Failed to delete LDAP entry: '#{@dn}'"
+				end
+				tries += 1
+				# reconnect and rebind.
+				do_connect()
+				retry
       rescue LDAP::ResultError => detail
         raise DeleteError, "Failed to delete LDAP entry: '#{@dn}'"
       end
@@ -669,7 +708,7 @@ module ActiveLDAP
       # We can't reuse @ldap_data because an exception would leave
       # an object in an unknown state
       @@logger.debug("#write: dup'ing @ldap_data")
-      ldap_data = @ldap_data.dup
+      ldap_data = Marshal.load(Marshal.dump(@ldap_data))
       @@logger.debug("#write: dup finished @ldap_data")
       @@logger.debug("#write: expanding subtypes in @ldap_data")
       ldap_data.keys.each do |key|
@@ -689,7 +728,7 @@ module ActiveLDAP
 
       # Expand subtypes to real data entries, but leave @data alone
       @@logger.debug("#write: dup'ing @data")
-      data = @data.dup
+      data = Marshal.load(Marshal.dump(@data))
       @@logger.debug("#write: finished dup'ing @data")
       @@logger.debug("#write: expanding subtypes for @data")
       data.keys.each do |key|
@@ -768,10 +807,21 @@ module ActiveLDAP
           end
         end
         @@logger.debug("#write: traversing data complete")
+        tries = 0
         begin
           @@logger.debug("#write: modifying #{@dn}")
           @@conn.modify(@dn, entry)
           @@logger.debug("#write: modify successful")
+				rescue RuntimeError => detail
+					#todo# check for 'no message' when retrying
+					# the connection may have gone stale. let's reconnect and retry. 
+					if tries > @max_retries
+						raise WriteError, "Could not update LDAP entry: #{detail}"
+					end
+					tries += 1
+					# reconnect and rebind.
+					do_connect()
+					retry
         rescue => detail
           raise WriteError, "Could not update LDAP entry: #{detail}"
         end
@@ -795,17 +845,27 @@ module ActiveLDAP
             entry.push(LDAP.mod(LDAP::LDAP_MOD_ADD|binary, pair[0], pair[1]))
           end
         end
+        tries = 0
         begin
           @@logger.debug("#write: adding #{@dn}")
           @@conn.add(@dn, entry)
           @@logger.debug("#write: add successful")
           @exists = true
+        rescue RuntimeError => e
+          # The connection may have gone stale. Let's reconnect and retry. 
+          if tries > @max_retries
+            raise WriteError, "Could not add LDAP entry[#{Base.connection.err2string(Base.connection.err)}]: #{detail}"
+          end
+          tries += 1
+          # Reconnect and rebind.
+          do_connect()
+          retry
         rescue LDAP::ResultError => detail
           raise WriteError, "Could not add LDAP entry[#{Base.connection.err2string(Base.connection.err)}]: #{detail}"
         end
       end
       @@logger.debug("#write: resetting @ldap_data to a dup of @data")
-      @ldap_data = @data.dup
+      @ldap_data = Marshal.load(Marshal.dump(@data))
       @@logger.debug("#write: @ldap_data reset complete")
       @@logger.debug("stub: write exitted")
     end
@@ -936,16 +996,16 @@ module ActiveLDAP
         # Build |data| from schema
         # clear attr_method mapping first
         @attr_methods = {}
-	@must = []
-	@may = []
+	      @must = []
+	      @may = []
         new_oc.each do |objc|
           # get all attributes for the class
           attributes = Base.schema.class_attributes(objc.to_s)
-	  @must += attributes[:must]
-	  @may += attributes[:may]
+	        @must += attributes[:must]
+	        @may += attributes[:may]
         end
-	@must.uniq!
-	@may.uniq!
+	      @must.uniq!
+	      @may.uniq!
         (@must+@may).each do |attr|
             # Update attr_method with appropriate
             define_attribute_methods(attr)
@@ -1053,6 +1113,36 @@ module ActiveLDAP
     end
 
 
+    # Performs the actually connection. This separate so that it may
+    # be called to refresh stale connections.
+    def Base.do_connect()
+			# Connect to LDAP
+			begin
+				# SSL using START_TLS
+				@@conn = LDAP::SSLConn.new(@@config[:host], @@config[:port], true)
+			rescue
+				@@logger.warn "Warning: Failed to connect using TLS!"
+				begin
+					@@logger.warn "Warning: Attempting SSL connection . . ."
+					@@conn = LDAP::SSLConn.new(@@config[:host], @@config[:port], false)
+					# HACK: Load the schema here because otherwise you can't tell if the
+					# HACK: SSLConn is a real SSL connection.
+					@@schema = @@conn.schema() if @@schema.nil?
+				rescue
+					@@logger.warn "Warning: Attempting unencrypted connection . . ."
+					@@conn = LDAP::Conn.new(@@config[:host], @@config[:port])
+				end
+			end
+			@@logger.debug "Connected to #{@@config[:host]}:#{@@config[:port]}."
+
+			# Enforce LDAPv3
+			@@conn.set_option(LDAP::LDAP_OPT_PROTOCOL_VERSION, 3)
+
+			# Authenticate
+			do_bind
+		end
+
+
      # Wrapper all bind activity
      def Base.do_bind()
        bind_dn = @@config[:bind_format] % [@@config[:user]]

metadata

@@ -1,10 +1,10 @@
 --- !ruby/object:Gem::Specification 
-rubygems_version: 0.8.10
+rubygems_version: 0.8.4
 specification_version: 1
 name: ruby-activeldap-debug
 version: !ruby/object:Gem::Version 
-  version: 0.5.7
-date: 2005-05-24
+  version: 0.5.8
+date: 2005-10-31
 summary: Ruby/ActiveLDAP is a object-oriented API to LDAP
 require_paths: 
   - lib
@@ -29,9 +29,9 @@ authors:
 files: 
   - lib/activeldap
   - lib/activeldap.rb
-  - lib/activeldap/configuration.rb
   - lib/activeldap/associations.rb
   - lib/activeldap/base.rb
+  - lib/activeldap/configuration.rb
   - lib/activeldap/schema2.rb
 test_files: []
 rdoc_options: []