Class: ActiveLdap::Base — activeldap - ActiveLdap

Class: ActiveLdap::Base

Inherits:
Object
  • Object
show all
Includes:
GetTextSupport, Reloadable::Deprecated, Reloadable::Subclasses
Defined in:
lib/active_ldap/base.rb

Overview

Base

Base is the primary class which contains all of the core ActiveLdap functionality. It is meant to only ever be subclassed by extension classes.

Direct Known Subclasses

Entry

Constant Summary

VALID_LDAP_MAPPING_OPTIONS =
[:dn_attribute, :prefix, :scope,
:classes, :recommended_classes,
:excluded_classes, :sort_by, :order]
@@configurations =
{}

Class Attribute Summary (collapse)

Class Method Summary (collapse)

Instance Method Summary (collapse)

Constructor Details

- (Base) initialize(attributes = nil) {|_self| ... }

new

Creates a new instance of Base initializing all class and all initialization. Defines local defaults. See examples If multiple values exist for dn_attribute, the first one put here will be authoritative

Yields:

  • (_self)

Yield Parameters:



666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
# File 'lib/active_ldap/base.rb', line 666

def initialize(attributes=nil)
  init_base
  @new_entry = true
  initial_classes = required_classes | recommended_classes
  case attributes
  when nil
    self.classes = initial_classes
  when String, Array, DN
    self.classes = initial_classes
    self.dn = attributes
  when Hash
    attributes = attributes.clone
    classes = extract_object_class!(attributes)
    self.classes = classes | initial_classes
    self.attributes = attributes
  else
    format = _("'%s' must be either nil, DN value as ActiveLdap::DN, " \
               "String or Array or attributes as Hash")
    raise ArgumentError, format % attributes.inspect
  end
  yield self if block_given?
  run_callbacks :initialize unless _initialize_callbacks.empty?
end

Class Attribute Details

+ (Object) abstract_class

Returns the value of attribute abstract_class



511
512
513
# File 'lib/active_ldap/base.rb', line 511

def abstract_class
  @abstract_class
end

Class Method Details

+ (Boolean) abstract_class?

Returns:

  • (Boolean)


512
513
514
# File 'lib/active_ldap/base.rb', line 512

def abstract_class?
  defined?(@abstract_class) && @abstract_class
end

+ (Object) base

Base.base

This method when included into Base provides an inheritable, overwritable configuration setting

This should be a string with the base of the ldap server such as 'dc=example,dc=com', and it should be overwritten by including configuration.rb into this class. When subclassing, the specified prefix will be concatenated.



439
440
441
# File 'lib/active_ldap/base.rb', line 439

def base
  @base ||= compute_base
end

+ (Object) base=(value)



444
445
446
447
# File 'lib/active_ldap/base.rb', line 444

def base=(value)
  self.inheritable_base = value
  @base = nil
end

+ (Object) base_class



472
473
474
475
476
477
478
# File 'lib/active_ldap/base.rb', line 472

def base_class
  if self == Base or superclass == Base
    self
  else
    superclass.base_class
  end
end

+ (Object) class_local_attr_accessor(search_ancestors, *syms)



303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
# File 'lib/active_ldap/base.rb', line 303

def self.class_local_attr_accessor(search_ancestors, *syms)
  syms.flatten.each do |sym|
    class_eval(<<-EOS, __FILE__, __LINE__ + 1)
      def self.#{sym}(search_superclasses=#{search_ancestors})
        @#{sym} ||= nil
        return @#{sym} if @#{sym}
        if search_superclasses
          target = superclass
          value = nil
          loop do
            break nil unless target.respond_to?(:#{sym})
            value = target.#{sym}
            break if value
            target = target.superclass
          end
          value
        else
          nil
        end
      end
      def #{sym}; self.class.#{sym}; end
      def self.#{sym}=(value); @#{sym} = value; end
    EOS
  end
end

+ (Object) class_of_active_ldap_descendant(klass)



516
517
518
519
520
521
522
523
524
525
# File 'lib/active_ldap/base.rb', line 516

def class_of_active_ldap_descendant(klass)
  if klass.superclass == Base or klass.superclass.abstract_class?
    klass
  elsif klass.superclass.nil?
    raise Error, _("%s doesn't belong in a hierarchy descending " \
                   "from ActiveLdap") % (name || to_s)
  else
    class_of_active_ldap_descendant(klass.superclass)
  end
end

+ (Object) create(attributes = nil, &block)



395
396
397
398
399
400
401
402
403
# File 'lib/active_ldap/base.rb', line 395

def create(attributes=nil, &block)
  if attributes.is_a?(Array)
    attributes.collect {|attrs| create(attrs, &block)}
  else
    object = new(attributes, &block)
    object.save
    object
  end
end

+ (Object) default_search_attribute



480
481
482
# File 'lib/active_ldap/base.rb', line 480

def default_search_attribute
  dn_attribute
end

+ (Object) establish_connection(config = nil)

establish_connection is deprecated since 1.1.0. Please use setup_connection() instead.



386
387
388
389
390
391
392
393
# File 'lib/active_ldap/base.rb', line 386

def establish_connection(config=nil)
  message =
    _("ActiveLdap::Base.establish_connection has been deprecated " \
      "since 1.1.0. " \
      "Please use ActiveLdap::Base.setup_connection instead.")
  ActiveSupport::Deprecation.warn(message)
  setup_connection(config)
end

+ (Object) human_name(options = {})



538
539
540
541
542
543
544
545
546
547
548
549
# File 'lib/active_ldap/base.rb', line 538

def human_name(options={})
  defaults = self_and_descendants_from_active_ldap.collect do |klass|
    if klass.name.blank?
      nil
    else
      :#{klass.name.underscore}"
    end
  end
  defaults << name.humanize
  defaults = defaults.compact
  defaults.first || name || to_s
end

+ (Object) inspect



484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
# File 'lib/active_ldap/base.rb', line 484

def inspect
  if self == Base
    super
  elsif abstract_class?
    "#{super}(abstract)"
  else
    detail = nil
    begin
      must = []
      may = []
      class_names = classes.collect do |object_class|
        must.concat(object_class.must)
        may.concat(object_class.may)
        object_class.name
      end
      detail = ["objectClass:<#{class_names.join(', ')}>",
                "must:<#{inspect_attributes(must)}>",
                "may:<#{inspect_attributes(may)}>"].join(", ")
    rescue ActiveLdap::ConnectionNotSetup
      detail = "not-connected"
    rescue ActiveLdap::Error
      detail = "connection-failure"
    end
    "#{super}(#{detail})"
  end
end

+ (Object) ldap_mapping(options = {})

This class function is used to setup all mappings between the subclass and ldap for use in activeldap

Example:

ldap_mapping :dn_attribute => 'uid', :prefix => 'ou=People',
             :classes => ['top', 'posixAccount'],
             :scope => :sub


412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
# File 'lib/active_ldap/base.rb', line 412

def ldap_mapping(options={})
  options = options.symbolize_keys
  validate_ldap_mapping_options(options)

  self.dn_attribute = options[:dn_attribute] || default_dn_attribute
  self.dn_attribute = dn_attribute.to_s if dn_attribute.is_a?(Symbol)
  self.prefix = options[:prefix] || default_prefix
  self.scope = options[:scope]
  self.required_classes = options[:classes]
  self.recommended_classes = options[:recommended_classes]
  self.excluded_classes = options[:excluded_classes]
  self.sort_by = options[:sort_by]
  self.order = options[:order]

  public_class_method :new
end

+ (Object) parsed_base

Base.base

This method when included into Base provides an inheritable, overwritable configuration setting

This should be a string with the base of the ldap server such as 'dc=example,dc=com', and it should be overwritten by including configuration.rb into this class. When subclassing, the specified prefix will be concatenated. for backward compatibility



442
443
444
# File 'lib/active_ldap/base.rb', line 442

def base
  @base ||= compute_base
end

+ (Object) prefix



449
450
451
# File 'lib/active_ldap/base.rb', line 449

def prefix
  @prefix ||= inheritable_prefix and DN.parse(inheritable_prefix)
end

+ (Object) prefix=(value)



453
454
455
456
457
# File 'lib/active_ldap/base.rb', line 453

def prefix=(value)
  self.inheritable_prefix = value
  @prefix = nil
  @base = nil
end

+ (Object) scope=(scope)



460
461
462
463
# File 'lib/active_ldap/base.rb', line 460

def scope=(scope)
  validate_scope(scope)
  self.scope_without_validation = scope
end

+ (Object) scope_without_validation=



459
# File 'lib/active_ldap/base.rb', line 459

alias_method :scope_without_validation=, :scope=

+ (Object) self_and_descendants_from_active_ldap



527
528
529
530
531
532
533
534
535
536
# File 'lib/active_ldap/base.rb', line 527

def self_and_descendants_from_active_ldap
  klass = self
  classes = [klass]
  while klass != klass.base_class
    classes << klass = klass.superclass
  end
  classes
rescue
  [self]
end

+ (Object) setup_connection(config = nil)

Set LDAP connection configuration up. It doesn't connect and bind to LDAP server. A connection to LDAP server is created when it's needed.

config

config must be a hash that may contain any of the following fields: :password_block, :logger, :host, :port, :base, :bind_dn, :try_sasl, :allow_anonymous :bind_dn specifies the DN to bind with. :password_block specifies a Proc object that will yield a String to

be used as the password when called.

:logger specifies a logger object (Logger, Log4r::Logger and s on) :host sets the LDAP server hostname :port sets the LDAP server port :base overwrites Base.base - this affects EVERYTHING :try_sasl indicates that a SASL bind should be attempted when binding

to the server (default: false)

:sasl_mechanisms is an array of SASL mechanism to try

(default: ["GSSAPI", "CRAM-MD5", "EXTERNAL"])

: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. -1 means infinite.

:sasl_quiet - if true, sets @sasl_quiet on the Ruby/LDAP connection :method - whether to use :ssl, :tls, or :plain (unencrypted) :retry_wait - seconds to wait before retrying a connection :scope - dictates how to find objects. ONELEVEL by default to

avoid dn_attr collisions across OUs. Think before changing.

:timeout - time in seconds - defaults to disabled. This CAN interrupt

search() requests. Be warned.

:retry_on_timeout - whether to reconnect when timeouts occur. Defaults

to true

See lib/active_ldap/configuration.rb for defaults for each option



378
379
380
381
382
# File 'lib/active_ldap/base.rb', line 378

def setup_connection(config=nil)
  super
  ensure_logger
  nil
end

+ (Object) validate_scope(scope)

Raises:



465
466
467
468
469
470
# File 'lib/active_ldap/base.rb', line 465

def validate_scope(scope)
  scope = scope.to_sym if scope.is_a?(String)
  return if scope.nil? or scope.is_a?(Symbol)
  raise ConfigurationError,
          _("scope '%s' must be a Symbol") % scope.inspect
end

Instance Method Details

- (Object) ==(comparison_object)

Returns true if the comparison_object is the same object, or is of the same type and has the same dn.



692
693
694
695
696
697
# File 'lib/active_ldap/base.rb', line 692

def ==(comparison_object)
  comparison_object.equal?(self) or
    (comparison_object.instance_of?(self.class) and
     comparison_object.dn == dn and
     !comparison_object.new_entry?)
end

- (Object) [](name, force_array = false)



879
880
881
882
883
884
885
# File 'lib/active_ldap/base.rb', line 879

def [](name, force_array=false)
  if name == "dn"
    array_of(dn, force_array)
  else
    get_attribute(name, force_array)
  end
end

- (Object) []=(name, value)



887
888
889
# File 'lib/active_ldap/base.rb', line 887

def []=(name, value)
  set_attribute(name, value)
end

- (Object) _

- (Object) assign_attributes(new_attributes)



825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
# File 'lib/active_ldap/base.rb', line 825

def assign_attributes(new_attributes)
  return if new_attributes.blank?

  _schema = _local_entry_attribute = nil
  targets = sanitize_for_mass_assignment(new_attributes)
  targets.each do |key, value|
    setter = "#{key}="
    unless respond_to?(setter)
      _schema ||= schema
      attribute = _schema.attribute(key)
      next if attribute.id.nil?
      _local_entry_attribute ||= local_entry_attribute
      _local_entry_attribute.register(attribute)
    end
    send(setter, value)
  end
end

- (Object) attribute_names(normalize = false)

attributes

Return attribute methods so that a program can determine available attributes dynamically without schema awareness



734
735
736
# File 'lib/active_ldap/base.rb', line 734

def attribute_names(normalize=false)
  entry_attribute.names(normalize)
end

- (Boolean) attribute_present?(name)

Returns:

  • (Boolean)


738
739
740
741
# File 'lib/active_ldap/base.rb', line 738

def attribute_present?(name)
  values = get_attribute(name, true)
  !values.empty? or values.any? {|x| !(x and x.empty?)}
end

- (Object) attributes

This returns the key value pairs in @data with all values cloned



809
810
811
812
# File 'lib/active_ldap/base.rb', line 809

def attributes
  @simplified_data ||= simplify_data(@data)
  @simplified_data.clone
end

- (Object) attributes=(new_attributes)

This allows a bulk update to the attributes of a record without forcing an immediate save or validation.

It is unwise to attempt objectClass updates this way. Also be sure to only pass in key-value pairs of your choosing. Do not let URL/form hackers supply the keys.



820
821
822
823
# File 'lib/active_ldap/base.rb', line 820

def attributes=(new_attributes)
  return if new_attributes.blank?
  assign_attributes(new_attributes)
end

- (Object) base



945
946
947
# File 'lib/active_ldap/base.rb', line 945

def base
  @base ||= compute_base
end

- (Object) base=(object_local_base)



949
950
951
952
953
954
# File 'lib/active_ldap/base.rb', line 949

def base=(object_local_base)
  ensure_update_dn
  @dn = nil
  @base = nil
  @base_value = object_local_base
end

- (Object) bind(config_or_password = {}, config_or_ignore = nil, &block)



891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
# File 'lib/active_ldap/base.rb', line 891

def bind(config_or_password={}, config_or_ignore=nil, &block)
  if config_or_password.is_a?(String)
    config = (config_or_ignore || {}).merge(:password => config_or_password)
  else
    config = config_or_password
  end
  config = {:bind_dn => dn, :allow_anonymous => false}.merge(config)
  config[:password_block] ||= block if block_given?
  setup_connection(config)

  before_connection = @connection
  begin
    @connection = nil
    connection.connect
    @connection = connection
    clear_connection_based_cache
    clear_association_cache
  rescue ActiveLdap::Error
    remove_connection
    @connection = before_connection
    raise
  end
  true
end

- (Object) clear_connection_based_cache



916
917
918
919
920
# File 'lib/active_ldap/base.rb', line 916

def clear_connection_based_cache
  @schema = nil
  @local_entry_attribute = nil
  clear_object_class_based_cache
end

- (Object) clear_object_class_based_cache



922
923
924
925
926
927
928
# File 'lib/active_ldap/base.rb', line 922

def clear_object_class_based_cache
  @entry_attribute = nil
  @real_names = {}
  @changed_attributes.reject! do |key, _|
    not attribute_method?(key)
  end
end

- (Object) clear_removed_attributes_data(removed_attributes)



930
931
932
933
934
935
936
937
938
939
# File 'lib/active_ldap/base.rb', line 930

def clear_removed_attributes_data(removed_attributes)
  return if removed_attributes.empty?
  removed_entry_attribute = EntryAttribute.new(nil, [])
  removed_attributes.each do |attribute|
    removed_entry_attribute.register(attribute)
  end
  @data.reject! do |key, _|
    removed_entry_attribute.exist?(key)
  end
end

- (Object) default_search_attribute



785
786
787
# File 'lib/active_ldap/base.rb', line 785

def default_search_attribute
  self.class.default_search_attribute
end

- (Object) delete_all(options = {})



966
967
968
# File 'lib/active_ldap/base.rb', line 966

def delete_all(options={})
  super({:base => dn}.merge(options || {}))
end

- (Object) destroy_all(options = {})



970
971
972
# File 'lib/active_ldap/base.rb', line 970

def destroy_all(options={})
  super({:base => dn}.merge(options || {}))
end

- (Object) dn

dn

Return the authoritative dn



754
755
756
# File 'lib/active_ldap/base.rb', line 754

def dn
  @dn ||= compute_dn
end

- (Object) dn=(value) Also known as: id=



773
774
775
# File 'lib/active_ldap/base.rb', line 773

def dn=(value)
  set_attribute(dn_attribute_with_fallback, value)
end

- (Object) dn_attribute



779
780
781
782
783
# File 'lib/active_ldap/base.rb', line 779

def dn_attribute
  ensure_update_dn
  _dn_attribute = @dn_attribute || dn_attribute_of_class
  to_real_attribute_name(_dn_attribute) || _dn_attribute
end

- (Object) dn_attribute_of_class



778
# File 'lib/active_ldap/base.rb', line 778

alias_method(:dn_attribute_of_class, :dn_attribute)

- (Boolean) eql?(comparison_object)

Delegates to ==

Returns:

  • (Boolean)


700
701
702
# File 'lib/active_ldap/base.rb', line 700

def eql?(comparison_object)
  self == (comparison_object)
end

- (Boolean) exist? Also known as: exists?

exist?

Return whether the entry exists in LDAP or not

Returns:

  • (Boolean)


746
747
748
# File 'lib/active_ldap/base.rb', line 746

def exist?
  self.class.exists?(dn)
end

- (Object) gettext

- (Object) hash

Delegates to id in order to allow two records of the same type and id to work with something like:

[ User.find("a"), User.find("b"), User.find("c") ] &
  [ User.find("a"), User.find("d") ] # => [ User.find("a") ]


708
709
710
711
712
713
714
715
716
717
718
719
720
# File 'lib/active_ldap/base.rb', line 708

def hash
  return super if @_hashing # workaround for GetText :<
  _dn = nil
  begin
    @_hashing = true
    _dn = dn
  rescue DistinguishedNameInvalid, DistinguishedNameNotSetError
    return super
  ensure
    @_hashing = false
  end
  _dn.hash
end

- (Boolean) have_attribute?(name, except = []) Also known as: has_attribute?

Returns:

  • (Boolean)


873
874
875
876
# File 'lib/active_ldap/base.rb', line 873

def have_attribute?(name, except=[])
  real_name = to_real_attribute_name(name)
  !real_name.nil? and !except.include?(real_name)
end

- (Object) id



758
759
760
# File 'lib/active_ldap/base.rb', line 758

def id
  get_attribute(dn_attribute_with_fallback)
end

- (Object) inspect



974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
# File 'lib/active_ldap/base.rb', line 974

def inspect
  object_classes = entry_attribute.object_classes
  inspected_object_classes = object_classes.collect do |object_class|
    object_class.name
  end.join(', ')
  must_attributes = must.collect(&:name).sort.join(', ')
  may_attributes = may.collect(&:name).sort.join(', ')
  inspected_attributes = attribute_names.sort.collect do |name|
    inspect_attribute(name)
  end.join(', ')
  result = "\#<#{self.class} objectClass:<#{inspected_object_classes}>, "
  result << "must:<#{must_attributes}>, may:<#{may_attributes}>, "
  result << "#{inspected_attributes}>"
  result
end

- (Object) may



722
723
724
# File 'lib/active_ldap/base.rb', line 722

def may
  entry_attribute.may
end

- (Object) must



726
727
728
# File 'lib/active_ldap/base.rb', line 726

def must
  entry_attribute.must
end

- (Object) schema



941
942
943
# File 'lib/active_ldap/base.rb', line 941

def schema
  @schema ||= super
end

- (Object) scope



957
958
959
# File 'lib/active_ldap/base.rb', line 957

def scope
  @scope || scope_of_class
end

- (Object) scope=(scope)



961
962
963
964
# File 'lib/active_ldap/base.rb', line 961

def scope=(scope)
  self.class.validate_scope(scope)
  @scope = scope
end

- (Object) scope_of_class



956
# File 'lib/active_ldap/base.rb', line 956

alias_method :scope_of_class, :scope

- (Object) to_key

Returns this entity’s dn wrapped in an Array or nil if the entity' s dn is not set.



767
768
769
770
771
# File 'lib/active_ldap/base.rb', line 767

def to_key
  [dn]
rescue DistinguishedNameNotSetError
  nil
end

- (Object) to_ldif



847
848
849
# File 'lib/active_ldap/base.rb', line 847

def to_ldif
  Ldif.new([to_ldif_record]).to_s
end

- (Object) to_ldif_record



843
844
845
# File 'lib/active_ldap/base.rb', line 843

def to_ldif_record
  super(dn, normalize_data(@data))
end

- (Object) to_param



762
763
764
# File 'lib/active_ldap/base.rb', line 762

def to_param
  id
end

- (Object) to_s



869
870
871
# File 'lib/active_ldap/base.rb', line 869

def to_s
  to_ldif
end

- (Object) to_xml(options = {})



851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
# File 'lib/active_ldap/base.rb', line 851

def to_xml(options={})
  options = options.dup
  options[:root] ||= (self.class.name || '').underscore
  options[:root] = 'anonymous' if options[:root].blank?
  [:only, :except].each do |attribute_names_key|
    names = options[attribute_names_key]
    next if names.nil?
    options[attribute_names_key] = names.collect do |name|
      if name.to_s.downcase == "dn"
        "dn"
      else
        to_real_attribute_name(name)
      end
    end.compact
  end
  XML.new(dn, normalize_data(@data), schema).to_s(options)
end

- (Object) update_attribute(name, value)

Updates a given attribute and saves immediately



790
791
792
793
# File 'lib/active_ldap/base.rb', line 790

def update_attribute(name, value)
  send("#{name}=", value)
  save
end

- (Object) update_attributes(attrs)

This performs a bulk update of attributes and immediately calls #save.



797
798
799
800
# File 'lib/active_ldap/base.rb', line 797

def update_attributes(attrs)
  self.attributes = attrs
  save
end

- (Object) update_attributes!(attrs)



802
803
804
805
# File 'lib/active_ldap/base.rb', line 802

def update_attributes!(attrs)
  self.attributes = attrs
  save!
end