activeldap 4.0.5 → 6.1.0

data/lib/active_ldap/attribute_methods/dirty.rb

@@ -9,8 +9,7 @@ module ActiveLdap
       def save(*) #:nodoc:
         succeeded = super
         if succeeded
-          @previously_changed = changes
-          @changed_attributes.clear
+          changes_applied
         end
         succeeded
       end
@@ -18,20 +17,18 @@ module ActiveLdap
       # Attempts to <tt>save!</tt> the record and clears changed attributes if successful.
       def save!(*) #:nodoc:
         super.tap do
-          @previously_changed = changes
-          @changed_attributes.clear
+          changes_applied
         end
       end
 
       # <tt>reload</tt> the record and clears changed attributes.
       def reload(*) #:nodoc:
         super.tap do
-          @previously_changed.clear
-          @changed_attributes.clear
+          clear_changes_information
         end
       end
 
-    protected
+      private
       def set_attribute(name, value)
         if name and name != "objectClass"
           attribute_will_change!(name) unless value == get_attribute(name)

data/lib/active_ldap/attribute_methods/query.rb

@@ -8,7 +8,7 @@ module ActiveLdap
         attribute_method_suffix '?'
       end
 
-    protected
+      private
       def get_attribute_as_query(name, force_array=false)
         name, value = get_attribute_before_type_cast(name, force_array)
         if force_array

data/lib/active_ldap/attribute_methods/read.rb

@@ -3,11 +3,15 @@ module ActiveLdap
     module Read
       extend ActiveSupport::Concern
 
-    protected
+      private
       def attribute(attr, *args)
         return get_attribute(attr, args.first)
       end
 
+      def _read_attribute(name)
+        get_attribute(name)
+      end
+
       # get_attribute
       #
       # Return the value of the attribute called by method_missing?

data/lib/active_ldap/attribute_methods/write.rb

@@ -7,7 +7,7 @@ module ActiveLdap
         attribute_method_suffix '='
       end
 
-    protected
+      private
       def attribute=(attr, *args)
         return set_attribute(attr, args.first)
       end

data/lib/active_ldap/attribute_methods.rb

@@ -13,8 +13,7 @@ module ActiveLdap
       end.flatten
     end
 
-    protected
-
+    private
     # overiding ActiveModel::AttributeMethods
     def attribute_method?(method_name)
       have_attribute?(method_name, ['objectClass'])

data/lib/active_ldap/base.rb

@@ -32,6 +32,7 @@
 require 'English'
 require 'thread'
 require 'erb'
+require 'set'
 
 module ActiveLdap
   # OO-interface to LDAP assuming pam/nss_ldap-style organization with
@@ -330,6 +331,7 @@ module ActiveLdap
     class_local_attr_accessor true, :dn_attribute, :scope, :sort_by, :order
     class_local_attr_accessor true, :required_classes, :recommended_classes
     class_local_attr_accessor true, :excluded_classes
+    class_local_attr_accessor false, :sub_classes
 
     class << self
       # Hide new in Base
@@ -340,6 +342,7 @@ module ActiveLdap
         sub_class.module_eval do
           include GetTextSupport
         end
+        (self.sub_classes ||= []) << sub_class
       end
 
       # Set LDAP connection configuration up. It doesn't connect
@@ -548,6 +551,20 @@ module ActiveLdap
         defaults.first || name || to_s
       end
 
+      protected
+      def find_real_class(object_classes)
+        (sub_classes || []).each do |sub_class|
+          real_class = sub_class.find_real_class(object_classes)
+          return real_class if real_class
+        end
+
+        if object_classes.superset?(Set.new(classes))
+          self
+        else
+          nil
+        end
+      end
+
       private
       def inspect_attributes(attributes)
         inspected_attribute_names = {}
@@ -594,12 +611,19 @@ module ActiveLdap
       def instantiate(args)
         dn, attributes, options = args
         options ||= {}
-        if self.class == Class
-          klass = self.ancestors[0].to_s.split(':').last
-          real_klass = self.ancestors[0]
+
+        object_classes_raw =
+          attributes["objectClass"] ||
+          attributes["objectclass"] ||
+          []
+        if sub_classes.nil? or object_classes_raw.empty?
+          real_klass = self
         else
-          klass = self.class.to_s.split(':').last
-          real_klass = self.class
+          object_classes = Set.new
+          object_classes_raw.each do |object_class_raw|
+            object_classes << schema.object_class(object_class_raw)
+          end
+          real_klass = find_real_class(object_classes) || self
         end
 
         obj = real_klass.allocate
@@ -827,6 +851,8 @@ module ActiveLdap
 
       _schema = _local_entry_attribute = nil
       targets = sanitize_for_mass_assignment(new_attributes)
+      have_dn = false
+      dn_value = nil
       targets.each do |key, value|
         setter = "#{key}="
         unless respond_to?(setter)
@@ -836,8 +862,15 @@ module ActiveLdap
           _local_entry_attribute ||= local_entry_attribute
           _local_entry_attribute.register(attribute)
         end
-        send(setter, value)
+        case setter
+        when "dn=", "id="
+          have_dn = true
+          dn_value = value
+        else
+          send(setter, value)
+        end
       end
+      self.dn = dn_value if have_dn
     end
 
     def to_ldif_record
@@ -922,9 +955,7 @@ module ActiveLdap
     def clear_object_class_based_cache
       @entry_attribute = nil
       @real_names = {}
-      @changed_attributes.reject! do |key, _|
-        not attribute_method?(key)
-      end
+      clear_changes_information
     end
 
     def clear_removed_attributes_data(removed_attributes)
@@ -1093,7 +1124,7 @@ module ActiveLdap
         end
         set_attribute(key, value)
       end
-      @changed_attributes.clear
+      clear_changes_information
     end
     private :initialize_attributes
 
@@ -1143,8 +1174,6 @@ module ActiveLdap
       @dn_split_value = nil
       @connection ||= nil
       @_hashing = false
-      @previously_changed = []
-      @changed_attributes = {}
       clear_connection_based_cache
     end
 
@@ -1261,6 +1290,7 @@ module ActiveLdap
     end
 
     def compute_base
+      ensure_update_dn
       base_of_class = self.class.base
       if @base_value.nil?
         base_of_class
@@ -1352,7 +1382,14 @@ module ActiveLdap
         if k == _dn_attribute
           new_dn_value = value[0]
         else
-          attributes.push([:replace, k, value])
+          if (v.size == 1 and value.size == 1) or force_replace?(k)
+            attributes.push([:replace, k, value])
+          else
+            removed_values = v - value
+            added_values = value - v
+            attributes.push([:delete, k, removed_values]) unless removed_values.empty?
+            attributes.push([:add, k, added_values]) unless added_values.empty?
+          end
         end
       end
 
@@ -1366,12 +1403,22 @@ module ActiveLdap
         # Detect subtypes and account for them
         # REPLACE will function like ADD, but doesn't hit EQUALITY problems
         # TODO: Added equality(attr) to Schema
-        attributes.push([:replace, k, value])
+        if force_replace?(k)
+          attributes.push([:replace, k, value])
+        else
+          attributes.push([:add, k, value])
+        end
       end
 
       [new_dn_value, attributes]
     end
 
+    def force_replace?(k)
+      attribute = schema.attribute(k)
+      attribute.single_value? or
+        attribute.binary? # TODO: this should probably explicitly check for fields with no equality matching rule instead
+    end
+
     def collect_all_attributes(data)
       dn_attr = dn_attribute
       dn_value = data[dn_attr]

data/lib/active_ldap/callbacks.rb

@@ -14,13 +14,12 @@ module ActiveLdap
     included do
       extend ActiveModel::Callbacks
       include ActiveModel::Validations::Callbacks
-      
+      singleton_class.class_eval do
+        prepend CallbackedInstantiatable
+      end
+
       define_model_callbacks :initialize, :find, :touch, :only => :after
       define_model_callbacks :save, :create, :update, :destroy
-      
-      class << self
-        alias_method_chain :instantiate, :callbacks
-      end
     end
 
     module ClassMethods
@@ -33,9 +32,9 @@ module ActiveLdap
       end
     end
 
-    module ClassMethods
-      def instantiate_with_callbacks(record)
-        object = instantiate_without_callbacks(record)
+    module CallbackedInstantiatable
+      def instantiate(record)
+        object = super(record)
         object.run_callbacks(:find)
         object.run_callbacks(:initialize)
         object

data/lib/active_ldap/configuration.rb

@@ -27,6 +27,7 @@ module ActiveLdap
     DEFAULT_CONFIG[:host] = '127.0.0.1'
     DEFAULT_CONFIG[:port] = nil
     DEFAULT_CONFIG[:method] = :plain  # :ssl, :tls, :plain allowed
+    DEFAULT_CONFIG[:tls_options] = nil
 
     DEFAULT_CONFIG[:bind_dn] = nil
     DEFAULT_CONFIG[:password_block] = nil
@@ -47,6 +48,15 @@ module ActiveLdap
     DEFAULT_CONFIG[:retry_on_timeout] = true
     DEFAULT_CONFIG[:follow_referrals] = true
 
+    # 500 is the default size limit value of OpenLDAP 2.4:
+    #   https://openldap.org/doc/admin24/limits.html#Global%20Limits
+    #
+    # We may change this when we find LDAP server that its the default
+    # size limit is smaller than 500.
+    DEFAULT_CONFIG[:page_size] = 500
+    # Whether using paged results if available.
+    DEFAULT_CONFIG[:use_paged_results] = true
+
     DEFAULT_CONFIG[:logger] = nil
 
     module ClassMethods
@@ -91,8 +101,8 @@ module ActiveLdap
         @@defined_configurations
       end
 
-      def remove_configuration_by_configuration(config)
-        @@defined_configurations.delete_if {|key, value| value == config}
+      def remove_configuration_by_key(key)
+        @@defined_configurations.delete(key)
       end
 
       CONNECTION_CONFIGURATION_KEYS = [:uri, :base, :adapter]
@@ -102,8 +112,22 @@ module ActiveLdap
         end
       end
 
+      def parent_configuration(target)
+        if target.is_a?(Base)
+          target = target.class
+        else
+          target = target.superclass
+        end
+        while target <= Base
+          config = defined_configurations[target.active_connection_key]
+          return config if config
+          target = target.superclass
+        end
+        default_configuration
+      end
+
       def merge_configuration(user_configuration, target=self)
-        configuration = default_configuration
+        configuration = parent_configuration(target).dup
         prepare_configuration(user_configuration).each do |key, value|
           case key
           when :base

data/lib/active_ldap/connection.rb

@@ -6,7 +6,7 @@ module ActiveLdap
 
     module ClassMethods
       @@active_connections = {}
-      @@allow_concurrency = false
+      @@allow_concurrency = true
 
       def thread_safe_active_connections
         @@active_connections[Thread.current.object_id] ||= {}
@@ -135,7 +135,7 @@ module ActiveLdap
         end
         config = configuration(key)
         conn = active_connections[key]
-        remove_configuration_by_configuration(config)
+        remove_configuration_by_key(key)
         active_connections.delete_if {|_key, value| value == conn}
         conn.disconnect! if conn
         config
@@ -165,11 +165,11 @@ module ActiveLdap
         connection.schema
       end
 
-      private
       def active_connection_key(k=self)
         k.name.blank? ? k.object_id : k.name
       end
 
+      private
       def determine_active_connection_name
         key = active_connection_key
         if active_connections[key] or configuration(key)
@@ -197,27 +197,9 @@ module ActiveLdap
         if Object.respond_to?(:java)
           "jndi"
         else
-          ruby_ldap_available = false
-          $LOAD_PATH.each do |path|
-            if File.exist?(File.join(path, "ldap", "ldif.rb"))
-              ruby_ldap_available = true
-              break
-            end
-          end
-          if !ruby_ldap_available and Object.const_defined?(:Gem)
-            ruby_ldap_available = gem_available?("ruby-ldap")
-          end
-          if ruby_ldap_available
-            "ldap"
-          else
-            "net-ldap"
-          end
+          "net-ldap"
         end
       end
-
-      def gem_available?(name)
-        not Gem::Specification.find_all_by_name(name).empty?
-      end
     end
 
     def setup_connection(config=nil)

data/lib/active_ldap/distinguished_name.rb

@@ -62,7 +62,7 @@ module ActiveLdap
 
       HEX_PAIR = "(?:[\\da-fA-F]{2})"
       STRING_CHARS_RE = /[^,=\+<>\#;\\\"]*/ #
-      PAIR_RE = /\\([,=\+<>\#;]|\\|\"|(#{HEX_PAIR}))/ #
+      PAIR_RE = /\\([,=\+<>\#;]|\\|\"| |(#{HEX_PAIR}))/ #
       HEX_STRING_RE = /\#(#{HEX_PAIR}+)/ #
       def scan_attribute_value(scanner)
         if scanner.scan(HEX_STRING_RE)

data/lib/active_ldap/human_readable.rb

@@ -17,11 +17,12 @@ module ActiveLdap
         if attribute_or_name.is_a?(Schema::Attribute)
           name = attribute_or_name.name
         else
-          attribute = schema.attribute(attribute_or_name.to_s)
+          attribute_name = attribute_or_name.to_s
+          attribute = schema.attribute(attribute_name)
           return nil if attribute.id.nil?
-          if attribute.name == attribute_or_name or
-              attribute.aliases.include?(attribute_or_name.to_s)
-            name = attribute_or_name
+          if attribute.name == attribute_name or
+              attribute.aliases.include?(attribute_name)
+            name = attribute_name
           else
             return nil
           end

data/lib/active_ldap/operations.rb

@@ -22,9 +22,23 @@ module ActiveLdap
     end
 
     module Common
-      VALID_SEARCH_OPTIONS = [:attribute, :value, :filter, :prefix,
-                              :classes, :scope, :limit, :attributes,
-                              :sort_by, :order, :connection, :base, :offset]
+      VALID_SEARCH_OPTIONS = [
+        :attribute,
+        :value,
+        :filter,
+        :prefix,
+        :classes,
+        :scope,
+        :limit,
+        :attributes,
+        :sort_by,
+        :order,
+        :connection,
+        :base,
+        :offset,
+        :use_paged_results,
+        :page_size,
+      ]
 
       def search(options={}, &block)
         validate_search_options(options)
@@ -62,6 +76,8 @@ module ActiveLdap
           :attributes => requested_attributes,
           :sort_by => options[:sort_by] || sort_by,
           :order => options[:order] || order,
+          :use_paged_results => options[:use_paged_results],
+          :page_size => options[:page_size],
         }
         options[:connection] ||= connection
         values = []
@@ -96,10 +112,11 @@ module ActiveLdap
         }
 
         attribute = attr || ensure_search_attribute
+        escaped_value = DN.escape_value(value)
         options_for_non_leaf = {
           :attribute => attr,
           :value => value,
-          :prefix => ["#{attribute}=#{value}", prefix].compact.join(","),
+          :prefix => ["#{attribute}=#{escaped_value}", prefix].compact.join(","),
           :limit => 1,
           :scope => :base,
         }
@@ -291,6 +308,9 @@ module ActiveLdap
         offset = options.delete(:offset) || offset
         options[:attributes] = options.delete(:attributes) || ['*']
         options[:attributes] |= ['objectClass']
+        if options.delete(:include_operational_attributes)
+          options[:attributes] |= ["+"]
+        end
         results = search(options).collect do |dn, attrs|
           instantiate([dn, attrs, {:connection => options[:connection]}])
         end

data/lib/active_ldap/persistence.rb

@@ -81,9 +81,10 @@ module ActiveLdap
       end
     end
 
-    def reload
+    def reload(options={})
       clear_association_cache
-      _, attributes = search(:value => id).find do |_dn, _attributes|
+      search_options = options.merge(value: id)
+      _, attributes = search(search_options).find do |_dn, _attributes|
         dn == _dn
       end
       if attributes.nil?

data/lib/active_ldap/populate.rb

@@ -1,9 +1,11 @@
 module ActiveLdap
   module Populate
     module_function
-    def ensure_base(base_class=nil)
+    def ensure_base(base_class=nil, options={})
       base_class ||= Base
       return unless base_class.search(:scope => :base).empty?
+      dc_base_class = options[:dc_base_class] || base_class
+      ou_base_class = options[:ou_base_class] || base_class
 
       base_dn = DN.parse(base_class.base)
       suffixes = []
@@ -15,11 +17,11 @@ module ActiveLdap
         begin
           case name.downcase
           when "dc"
-            ensure_dc(value, prefix, base_class)
+            ensure_dc(value, prefix, dc_base_class)
           when "ou"
             ensure_ou(value,
                       :base => prefix,
-                      :base_class => base_class)
+                      :base_class => ou_base_class)
           end
         rescue ActiveLdap::OperationNotPermitted
         end

data/lib/active_ldap/railties/controller_runtime.rb

@@ -6,8 +6,7 @@ module ActiveLdap
     module ControllerRuntime #:nodoc:
       extend ActiveSupport::Concern
 
-    protected
-
+      private
       attr_internal :ldap_runtime
 
       def process_action(action, *args)

data/lib/active_ldap/schema/syntaxes.rb

@@ -192,11 +192,11 @@ module ActiveLdap
             fraction = fraction.to_f if fraction
             time_zone = match_data[-1]
             arguments = [
-              year, month, day, hour, minute, second, fraction, time_zone,
+              value, year, month, day, hour, minute, second, fraction, time_zone,
               Time.now,
             ]
-            if Time.method(:make_time).arity == 10
-              arguments.unshift(value)
+            if Time.method(:make_time).arity == 11
+              arguments[2, 0] = nil
             end
             begin
               Time.send(:make_time, *arguments)
@@ -222,7 +222,11 @@ module ActiveLdap
             if value.gmt?
               normalized_value + "Z"
             else
-              normalized_value + ("%+03d%02d" % value.gmtoff.divmod(3600))
+              # for timezones with non-zero minutes, such as IST which is +0530,
+              # divmod(3600) will give wrong value of 1800
+
+              offset = value.gmtoff / 60 # in minutes
+              normalized_value + ("%+03d%02d" % offset.divmod(60))
             end
           else
             value

data/lib/active_ldap/validations.rb

@@ -53,15 +53,23 @@ module ActiveLdap
       errors.empty? && output
     end
 
-    def save(*)
-      valid? ? super : false
+    def save(**options)
+      perform_validations(options) ? super : false
     end
 
-    def save!(*)
-      valid? ? super : raise(EntryInvalid.new(self))
+    def save!(**options)
+      perform_validations(options) ? super : raise(EntryInvalid.new(self))
     end
 
     private
+    def perform_validations(options)
+      if options[:validate] == false
+        true
+      else
+        valid?(options[:context])
+      end
+    end
+
     def format_validation_message(format, parameters)
       format % parameters
     end

data/lib/active_ldap/version.rb

@@ -1,3 +1,3 @@
 module ActiveLdap
-  VERSION = "4.0.5"
+  VERSION = "6.1.0"
 end

data/lib/active_ldap.rb

@@ -1,4 +1,3 @@
-require "rubygems"
 require "active_model"
 require "active_support/core_ext"
 
@@ -8,12 +7,6 @@ module ActiveLdap
   autoload :Command, "active_ldap/command"
 end
 
-if RUBY_PLATFORM.match('linux')
-  require 'active_ldap/timeout'
-else
-  require 'active_ldap/timeout_stub'
-end
-
 require 'active_ldap/get_text'
 
 require 'active_ldap/compatible'

data/po/en/active-ldap.po

@@ -7,7 +7,7 @@ msgid ""
 msgstr ""
 "Project-Id-Version: Ruby/ActiveLdap 1.1.1\n"
 "POT-Creation-Date: 2009-08-04 23:26+0900\n"
-"PO-Revision-Date: 2009-02-25 08:40+0900\n"
+"PO-Revision-Date: 2016-05-13 21:52+0900\n"
 "Last-Translator: Kouhei Sutou <kou@cozmixng.org>\n"
 "Language-Team: English\n"
 "MIME-Version: 1.0\n"
@@ -3524,7 +3524,7 @@ msgstr ""
 
 #: lib/active_ldap/adapter/base.rb:579
 msgid ""
-"Reconnect to server failed: %s\n"
+"Reconnect to server failed: %s: %s\n"
 "Reconnect to server failed backtrace:\n"
 "%s"
 msgstr ""

data/po/ja/active-ldap.po

@@ -7,7 +7,7 @@ msgid ""
 msgstr ""
 "Project-Id-Version: Ruby/ActiveLdap 1.1.1\n"
 "POT-Creation-Date: 2009-08-04 23:26+0900\n"
-"PO-Revision-Date: 2009-08-04 23:28+0900\n"
+"PO-Revision-Date: 2016-05-13 21:53+0900\n"
 "Last-Translator: Kouhei Sutou <kou@cozmixng.org>\n"
 "Language-Team: Japanese\n"
 "MIME-Version: 1.0\n"
@@ -3533,11 +3533,11 @@ msgstr "再接続を試みています"
 
 #: lib/active_ldap/adapter/base.rb:579
 msgid ""
-"Reconnect to server failed: %s\n"
+"Reconnect to server failed: %s: %s\n"
 "Reconnect to server failed backtrace:\n"
 "%s"
 msgstr ""
-"サーバへの再接続が失敗しました: %s\n"
+"サーバへの再接続が失敗しました: %s: %s\n"
 "サーバへの再接続失敗時のバックトレース:\n"
 "%s"
 

data/test/add-phonetic-attribute-options-to-slapd.ldif

@@ -1,6 +1,6 @@
-# Your LDAP server need to accept 'phonetic' attribute option for test.
-# This is a LDIF file for OpenLDAP to do the confiugration.
-# You can use this file by the following command linne on Debian GNU/Linux
+# Your LDAP server needs to accept 'phonetic' attribute option for test.
+# This is a LDIF file for OpenLDAP to do the configuration.
+# You can use this file by the following command line on Debian GNU/Linux
 # or Ubuntu:
 #   % sudo -H ldapmodify -Y EXTERNAL -H ldapi:/// -f test/add-phonetic-attribute-options-to-slapd.ldif
 version: 1