Class: LDAP::Schema2

Inherits:
Schema
  • Object
show all
Defined in:
lib/activeldap/schema2.rb

Constant Summary collapse

@@attr_cache = 
{}
@@class_cache = 
{}

Instance Method Summary collapse

Instance Method Details

#attr(sub, type, at) ⇒ Object

attr

This is just like LDAP::Schema#attr except that it allows look up in any of the given keys. e.g.

attr('attributeTypes', 'cn', 'DESC')
attr('ldapSyntaxes', '1.3.6.1.4.1.1466.115.121.1.5', 'DESC')



16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
 
# File 'lib/activeldap/schema2.rb', line 16

def attr(sub, type, at)
  return [] if sub.empty?
  return [] if type.empty?
  return [] if at.empty?

  type = type.downcase # We're going case insensitive.

  # Check already parsed options first
  if @@attr_cache.has_key? sub \
    and @@attr_cache[sub].has_key? type \
    and @@attr_cache[sub][type].has_key? at
      return @@attr_cache[sub][type][at].dup
  end

  # Initialize anything that is required
  unless @@attr_cache.has_key? sub
    @@attr_cache[sub] = {}
  end
  
  unless @@attr_cache[sub].has_key? type
    @@attr_cache[sub][type] = {}
  end

  at = at.upcase
  self[sub].each do |s|
    line = '' 
    if type[0..0] =~ /[0-9]/
      if s =~ /\(\s+(?i:#{type})\s+(?:[A-Z]|\))/
        line = s
      end
    else
      if s =~ /NAME\s+\(?.*'(?i:#{type})'.*\)?\s+(?:[A-Z]|\))/
        line = s
      end
    end

    # I need to check, but I think some of these matchs
    # overlap. I'll need to check these when I'm less sleepy.
    multi = ''
    case line
      when /#{at}\s+[\)A-Z]/
        @@attr_cache[sub][type][at] = ['TRUE']
        return ['TRUE']
      when /#{at}\s+'(.+?)'/
        @@attr_cache[sub][type][at] = [$1]
        return [$1]
      when /#{at}\s+\((.+?)\)/
        multi = $1
      when /#{at}\s+\(([\w\d\s\.]+)\)/
        multi = $1
      when /#{at}\s+([\w\d\.]+)/
        @@attr_cache[sub][type][at] = [$1]
        return [$1]
    end
    # Split up multiple matches
    # if oc then it is sep'd by $
    # if attr then bu spaces
    if multi.match(/\$/)
      @@attr_cache[sub][type][at] = multi.split("$").collect{|attr| attr.strip}
      return @@attr_cache[sub][type][at].dup
    elsif not multi.empty?
      @@attr_cache[sub][type][at] = multi.gsub(/'/, '').split(' ').collect{|attr| attr.strip}
      return @@attr_cache[sub][type][at].dup
    end
  end
  @@attr_cache[sub][type][at] = []
  return []
end

#attribute_aliases(attr) ⇒ Object

attribute_aliases

Returns all names from the LDAP schema for the attribute given.



89
90
91
 
# File 'lib/activeldap/schema2.rb', line 89

def attribute_aliases(attr)
  attr('attributeTypes', attr, 'NAME')
end

#binary?(attr) ⇒ Boolean

binary?

Returns true if the given attribute’s syntax is X-NOT-HUMAN-READABLE or X-BINARY-TRANSFER-REQUIRED

Returns:

  • (Boolean) 


118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
 
# File 'lib/activeldap/schema2.rb', line 118

def binary?(attr)
  # Get syntax OID
  syntax = attr('attributeTypes', attr, 'SYNTAX')
  return false if syntax.empty?

  # This seems to indicate binary
  result = attr('ldapSyntaxes', syntax[0], 'X-NOT-HUMAN-READABLE')
  return true if result[0] == "TRUE"

  # Get if binary transfer is required (non-binary types)
  # Usually these have the above tag
  result = attr('ldapSyntaxes', syntax[0], 'X-BINARY-TRANSFER-REQUIRED')
  return true if result[0] == "TRUE"

  return false
end

#binary_required?(attr) ⇒ Boolean

binary_required?

Returns true if the value MUST be transferred in binary

Returns:

  • (Boolean) 


138
139
140
141
142
143
144
145
146
147
148
149
 
# File 'lib/activeldap/schema2.rb', line 138

def binary_required?(attr)
  # Get syntax OID
  syntax = attr('attributeTypes', attr, 'SYNTAX')
  return false if syntax.empty?

  # Get if binary transfer is required (non-binary types)
  # Usually these have the above tag
  result = attr('ldapSyntaxes', syntax[0], 'X-BINARY-TRANSFER-REQUIRED')
  return true if result[0] == "TRUE"

  return false
end

#class_attributes(objc) ⇒ Object

class_attributes

Returns an Array of all the valid attributes (but not with full aliases) for the given objectClass



155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
 
# File 'lib/activeldap/schema2.rb', line 155

def class_attributes(objc)
  if @@class_cache.has_key? objc
    return @@class_cache[objc]
  end

  # Setup the cache
  @@class_cache[objc] = {}

  # First get all the current level attributes
  @@class_cache[objc] = {:must => attr('objectClasses', objc, 'MUST'), 
    :may => attr('objectClasses', objc, 'MAY')}

  # Now add all attributes from the parent object (SUPerclasses)
  # Hopefully an iterative approach will be pretty speedy
  # 1. build complete list of SUPs
  # 2. Add attributes from each
  sups = attr('objectClasses', objc, 'SUP')
  loop do 
    start_size = sups.size
  new_sups = []
    sups.each do |sup|
      new_sups += attr('objectClasses', sup, 'SUP')
    end

  sups += new_sups
  sups.uniq!
    break if sups.size == start_size
  end
  sups.each do |sup|
    @@class_cache[objc][:must] += attr('objectClasses', sup, 'MUST')
  @@class_cache[objc][:may] += attr('objectClasses', sup, 'MAY')
  end

  # Clean out the dupes.
  @@class_cache[objc][:must].uniq!
  @@class_cache[objc][:may].uniq!

  # Return the cached value
  return @@class_cache[objc].dup
end

#read_only?(attr) ⇒ Boolean

read_only?

Returns true if an attribute is read-only NO-USER-MODIFICATION

Returns:

  • (Boolean) 


97
98
99
100
101
 
# File 'lib/activeldap/schema2.rb', line 97

def read_only?(attr)
  result = attr('attributeTypes', attr, 'NO-USER-MODIFICATION')
  return true if result[0] == 'TRUE'
  return false 
end

#single_value?(attr) ⇒ Boolean

single_value?

Returns true if an attribute can only have one value defined SINGLE-VALUE

Returns:

  • (Boolean) 


108
109
110
111
112
 
# File 'lib/activeldap/schema2.rb', line 108

def single_value?(attr)
  result = attr('attributeTypes', attr, 'SINGLE-VALUE')
  return true if result[0] == 'TRUE'
  return false 
end