|
#!/usr/bin/ruby -Ku
|
|
|
|
$KCODE = 'UTF8'
|
|
require 'jcode'
|
|
require 'yaml'
|
|
require 'active_ldap'
|
|
require 'cmdparse2'
|
|
require 'pathname'
|
|
|
|
class Hash
|
|
def recursive_symbolize_keys!
|
|
symbolize_keys!
|
|
values.select { |v| v.is_a?(Hash) }.each { |h| h.recursive_symbolize_keys! }
|
|
self
|
|
end
|
|
end
|
|
|
|
config_str_prv = IO.read("config/private.conf")
|
|
config_str = IO.read("config/test.conf")
|
|
config = YAML.load(config_str_prv).merge(YAML.load(config_str)).recursive_symbolize_keys!
|
|
ActiveLdap::Base.setup_connection(config[:ldap])
|
|
|
|
cmdparser = CmdParse::CommandParser.new(true)
|
|
cmdparser.program_name = ""
|
|
cmdparser.program_version = [0, 0, 1]
|
|
|
|
cmdparser.options = CmdParse::OptionParserWrapper.new do |opt|
|
|
opt.separator "Global options:"
|
|
opt.on("--debug", "Output debug info without being formated") {|t| $debug_opt = true }
|
|
opt.on("--expert", "Output extra info for expert users") {|t| $expert_opt = true }
|
|
opt.on("--handles", "Output with handles (objects/field/... keys used for manipulations)") {|t| $handles_opt = true }
|
|
end
|
|
|
|
cmdparser.add_command(CmdParse::HelpCommand.new)
|
|
cmdparser.add_command(CmdParse::VersionCommand.new)
|
|
|
|
|
|
module ActiveLdap
|
|
class DistinguishedName
|
|
def shift
|
|
@rdns.shift
|
|
end
|
|
end
|
|
end
|
|
|
|
module LdapMapper
|
|
class LdapObject < ActiveLdap::Base
|
|
class_inheritable_accessor :presentation, :mapper
|
|
|
|
ldap_mapping :prefix => '', :classes => ['top'], :scope => :sub
|
|
|
|
# temporary method until active_ldap is fixed: return a DN object (see #23932)
|
|
def dn_obj
|
|
ActiveLdap::DistinguishedName.parse(self.dn)
|
|
end
|
|
|
|
def name
|
|
name = self[dn_attribute].is_a?(Array) ? self[dn_attribute][0] : self[dn_attribute]
|
|
name.strip
|
|
end
|
|
|
|
def human_name
|
|
[self.class.presentation[:name_attribute], 'displayName', 'cn'].each do |attr|
|
|
if self.has_attribute?(attr) and self.attribute_present?(attr)
|
|
name = self[attr].is_a?(Array) ? self[attr][0] : self[attr]
|
|
return name.strip
|
|
end
|
|
end
|
|
return ""
|
|
end
|
|
|
|
def description
|
|
[self.class.presentation[:desc_attribute], 'description'].each do |attr|
|
|
if self.has_attribute?(attr) and self.attribute_present?(attr)
|
|
return self[attr].is_a?(Array) ? self[attr][0] : self[attr]
|
|
end
|
|
end
|
|
return ""
|
|
end
|
|
|
|
def possible_relations
|
|
self.associations.collect {|assoc| assoc.to_s } - ['children']
|
|
end
|
|
|
|
def relations
|
|
rel_list = []
|
|
|
|
rel_list += self.class.presentation[:associated_relations] if self.class.presentation[:associated_relations]
|
|
|
|
aspects.each do |aspect|
|
|
aspect_data = self.class.mapper.get_aspect(aspect)
|
|
if defined?(aspect_data[:presentation][:associated_relations]) and aspect_data[:presentation][:associated_relations]
|
|
rel_list += aspect_data[:presentation][:associated_relations]
|
|
end
|
|
end
|
|
|
|
rel_list & possible_relations
|
|
end
|
|
|
|
def aspects
|
|
present_aspects = []
|
|
(self.class.presentation[:allowed_aspects] || []).each do |aspect|
|
|
aspect_data = self.class.mapper.get_aspect(aspect)
|
|
aspect_mapping = aspect_data[:mapping]
|
|
present_aspects << aspect if self.classes & aspect_mapping[:classes] == aspect_mapping[:classes]
|
|
end
|
|
|
|
present_aspects
|
|
end
|
|
|
|
def objectclasses_attr_list(objectclass_list)
|
|
objectclass_list = [objectclass_list] unless objectclass_list.is_a? Array
|
|
list = []
|
|
objectclass_list.each do |objectclass|
|
|
objectclass_obj = ActiveLdap::Base.schema.object_class(objectclass)
|
|
attr_list = objectclass_obj.must + objectclass_obj.may
|
|
list += attr_list.collect{|attr| attr.human_attribute_name }
|
|
end
|
|
list
|
|
end
|
|
|
|
def organized_data(options = {})
|
|
options.symbolize_keys!
|
|
options[:expert] ||= false;
|
|
options[:skip_binary] ||= false;
|
|
|
|
ignored_attrs = self.class.presentation[:hidden_attributes] || []
|
|
ignored_attrs += (self.class.presentation[:expert_attributes] || []) unless options[:expert]
|
|
attr_list = self.attributes.keys - ignored_attrs
|
|
|
|
aspects = self.aspects
|
|
rel_list = self.possible_relations
|
|
|
|
# first pass to take aspects forced relations into account
|
|
obj_aspects = {}
|
|
aspects.each do |aspect|
|
|
aspect_data = self.class.mapper.get_aspect(aspect)
|
|
|
|
if defined?(aspect_data[:presentation][:associated_attributes]) and aspect_data[:presentation][:associated_attributes]
|
|
taken_attr_list = aspect_data[:presentation][:associated_attributes] & (attr_list + ignored_attrs)
|
|
unless taken_attr_list.empty?
|
|
obj_aspects[aspect] ||= {}
|
|
obj_aspects[aspect].merge!(fetch_attributes_data(taken_attr_list, options))
|
|
attr_list -= taken_attr_list
|
|
end
|
|
end
|
|
|
|
if defined?(aspect_data[:presentation][:associated_relations]) and aspect_data[:presentation][:associated_relations]
|
|
taken_rel_list = aspect_data[:presentation][:associated_relations] & rel_list
|
|
unless taken_rel_list.empty?
|
|
obj_aspects[aspect] ||= {}
|
|
obj_aspects[aspect].merge!(fetch_relations_data(taken_rel_list, options))
|
|
rel_list -= taken_rel_list
|
|
end
|
|
end
|
|
end
|
|
|
|
# manage general attributes
|
|
obj_info = {}
|
|
if self.class.presentation[:associate_unclaimed_attributes]
|
|
taken_attr_list = attr_list
|
|
else
|
|
taken_attr_list = []
|
|
if self.class.presentation.has_key?(:associated_attributes)
|
|
taken_attr_list += self.class.presentation[:associated_attributes]
|
|
end
|
|
taken_attr_list += objectclasses_attr_list(self.required_classes + (self.class.presentation[:optional_classes] || []))
|
|
end
|
|
taken_attr_list = taken_attr_list.uniq & attr_list
|
|
obj_info = fetch_attributes_data(taken_attr_list, options)
|
|
attr_list -= taken_attr_list
|
|
|
|
# manage general relations
|
|
if self.class.presentation[:associated_relations]
|
|
taken_rel_list = self.class.presentation[:associated_relations] & rel_list
|
|
unless taken_rel_list.empty?
|
|
obj_info.merge!(fetch_relations_data(taken_rel_list, options))
|
|
rel_list -= taken_rel_list
|
|
end
|
|
end
|
|
|
|
# second pass to dispath the remaining attributes
|
|
unless attr_list.empty?
|
|
aspects.each do |aspect|
|
|
aspect_data = self.class.mapper.get_aspect(aspect)
|
|
|
|
taken_attr_list = (objectclasses_attr_list(aspect_data[:mapping][:classes]) & attr_list)
|
|
obj_aspects[aspect] ||= {}
|
|
obj_aspects[aspect].merge!(fetch_attributes_data(taken_attr_list, options))
|
|
attr_list -= taken_attr_list
|
|
|
|
break if attr_list.empty?
|
|
end
|
|
end
|
|
|
|
[obj_info, obj_aspects]
|
|
end
|
|
|
|
def family_parent_dn
|
|
pdn = self.dn_obj.dup
|
|
pdn.shift
|
|
pdn
|
|
end
|
|
|
|
def family_children
|
|
LdapObject.find(:all, :base => self.dn, :scope => :one)
|
|
end
|
|
|
|
def family_children_dn
|
|
self.family_children.collect {|obj| obj.dn }
|
|
end
|
|
|
|
def family_siblings
|
|
# cannot substract, as the ruby object signature may be different
|
|
LdapObject.find(:all, :base => self.family_parent_dn.to_s, :scope => :one).select{|obj| obj.dn != self.dn }
|
|
end
|
|
|
|
def family_siblings_dn
|
|
self.family_siblings.collect {|obj| obj.dn }
|
|
end
|
|
|
|
protected
|
|
|
|
def fetch_attributes_data(attr_list, options = {})
|
|
attr_data = self.attributes.select {|key, val| attr_list.include?(key) and not (options[:skip_binary] and ActiveLdap::Base.schema.attribute(key).binary?) }
|
|
Hash[attr_data]
|
|
end
|
|
|
|
def fetch_relations_data(rel_list, options = {})
|
|
rel_data = rel_list.collect do |rel|
|
|
data = self.send(rel).collect{|g| g.name }
|
|
data.empty? ? nil : ["rel:" + rel, data]
|
|
end
|
|
Hash[rel_data.compact]
|
|
end
|
|
end
|
|
|
|
class Controller
|
|
def initialize(mod_container = LdapMapper::Objects)
|
|
@mod_container = mod_container
|
|
@object_definitions = {}
|
|
@aspects = {}
|
|
end
|
|
|
|
def set_aspect(aspect_name, aspect_def)
|
|
@aspects[aspect_name] = aspect_def
|
|
end
|
|
|
|
def get_aspect(aspect_name)
|
|
@aspects[aspect_name.to_sym]
|
|
end
|
|
|
|
def self.object_name_to_klass_name(obj_name)
|
|
"LdapObject" + obj_name.to_s.capitalize
|
|
end
|
|
|
|
def load_object(obj_name, obj_def)
|
|
obj_mapping = obj_def[:mapping]
|
|
klass_name = self.class.object_name_to_klass_name(obj_name)
|
|
|
|
# create class
|
|
@mod_container.module_eval(<<-EOS)
|
|
class #{klass_name} < LdapMapper::LdapObject; end
|
|
EOS
|
|
|
|
# configure class
|
|
klass = find_klass(obj_name)
|
|
klass.presentation = obj_def[:presentation]
|
|
klass.mapper = self
|
|
klass.ldap_mapping obj_mapping.reject {|key, val| not ActiveLdap::Base::VALID_LDAP_MAPPING_OPTIONS.include?(key) }
|
|
|
|
# store definition for later relations processing
|
|
@object_definitions[obj_name] = obj_def
|
|
end
|
|
|
|
def find_klass(obj_name)
|
|
klass_name = self.class.object_name_to_klass_name(obj_name)
|
|
return nil unless @mod_container.const_defined?(klass_name)
|
|
@mod_container.const_get(klass_name)
|
|
end
|
|
|
|
# run it _once_ when all objects are loaded
|
|
def load_relations
|
|
@object_definitions.each_pair do |obj_name, obj_def|
|
|
obj_rel = {}
|
|
obj_rel.merge!(obj_def[:relations]) if obj_def.include?(:relations)
|
|
if obj_def[:presentation].has_key?(:allowed_aspects)
|
|
obj_def[:presentation][:allowed_aspects].each do |rel|
|
|
rel_data = get_aspect(rel)
|
|
obj_rel.merge!(rel_data[:relations]) if rel_data.has_key?(:relations) and rel_data[:relations]
|
|
end
|
|
end
|
|
next if obj_rel.empty?
|
|
|
|
klass = find_klass(obj_name)
|
|
|
|
obj_rel.each_pair do |field_name, rel|
|
|
foreign_klass = find_klass(rel[:object])
|
|
rel[:class_name] = foreign_klass.to_s
|
|
|
|
case rel[:type]
|
|
when :belongs_to
|
|
klass.belongs_to field_name, rel.reject {|key, val| not ActiveLdap::Associations::ClassMethods::VALID_BELONGS_TO_OPTIONS.include?(key) }
|
|
when :has_many
|
|
klass.has_many field_name, rel.reject {|key, val| not ActiveLdap::Associations::ClassMethods::VALID_HAS_MANY_OPTIONS.include?(key) }
|
|
else
|
|
raise "bug in '#{obj_name}' object relations (wrong type)"
|
|
end
|
|
end
|
|
end
|
|
end
|
|
end
|
|
|
|
# default location for mapped objects
|
|
module Objects
|
|
end
|
|
end
|
|
|
|
|
|
I18n.load_path += Dir[File.join(Pathname.new(".").realpath, "locale", "*.yml")]
|
|
I18n.default_locale = :en
|
|
|
|
ldapctl = LdapMapper::Controller.new
|
|
config[:aspects].each_pair do |aspect_name, aspect_data|
|
|
ldapctl.set_aspect(aspect_name, aspect_data)
|
|
end
|
|
config[:objects].each_pair do |obj_name, obj_data|
|
|
ldapctl.load_object(obj_name, obj_data)
|
|
end
|
|
ldapctl.load_relations
|
|
|
|
cmd = CmdParse::Command.new('list', false)
|
|
cmd.short_desc = "list objects"
|
|
cmd.set_execution_block do |args|
|
|
if args.size != 1
|
|
STDERR.puts "syntax error: no object name given"
|
|
exit 1
|
|
end
|
|
|
|
obj_hdl = args[0]
|
|
obj_klass = ldapctl.find_klass(obj_hdl)
|
|
if obj_klass.nil?
|
|
STDERR.puts "No such object '#{obj_hdl}'."
|
|
exit 2
|
|
end
|
|
|
|
obj_human_name = I18n.t(obj_hdl, :scope => 'objects', :default => "Object '#{obj_hdl}'")
|
|
puts "=== List of #{obj_human_name.pluralize} ==="
|
|
obj_klass.find(:all).each do |obj|
|
|
str = obj.human_name
|
|
str += " [#{obj.name}]" if $handles_opt
|
|
str += ": #{obj.description}" unless obj.description.empty?
|
|
puts str
|
|
end
|
|
end
|
|
cmdparser.add_command(cmd)
|
|
|
|
def translate_data_key(name)
|
|
if name.index(":")
|
|
type, key = name.split(":")
|
|
case type
|
|
when 'rel'
|
|
I18n.t(key, :scope => 'relations', :default => name)
|
|
else
|
|
raise "Cannot translate unknown data key type"
|
|
end
|
|
else
|
|
att = ActiveLdap::Base.schema.attribute(name)
|
|
I18n.t(att.human_attribute_name, :scope => 'attribute_types', :default => att.human_attribute_description)
|
|
end
|
|
end
|
|
|
|
def display_data(attr_data)
|
|
attr_data.each_pair do |key, val|
|
|
field_name = translate_data_key(key)
|
|
field_name += " [#{key}]" if $handles_opt
|
|
puts field_name + ": " + (val.is_a?(Array) ? val.sort.collect{|v| v.to_s }.join(", ") : val.to_s)
|
|
end
|
|
end
|
|
|
|
cmd = CmdParse::Command.new('show', false)
|
|
cmd.short_desc = "show object information"
|
|
cmd.set_execution_block do |args|
|
|
if args.size < 1
|
|
STDERR.puts "syntax error: no object name given"
|
|
exit 1
|
|
end
|
|
if args.size < 2
|
|
STDERR.puts "syntax error: no item name given"
|
|
exit 1
|
|
end
|
|
|
|
obj_hdl = args[0]
|
|
obj_klass = ldapctl.find_klass(obj_hdl)
|
|
if obj_klass.nil?
|
|
STDERR.puts "No such object '#{obj_hdl}'."
|
|
exit 2
|
|
end
|
|
|
|
item_hdl = args[1]
|
|
begin
|
|
item = obj_klass.find(item_hdl)
|
|
rescue ActiveLdap::EntryNotFound
|
|
STDERR.puts "No such item '#{obj_hdl}/#{item_hdl}'"
|
|
exit 2
|
|
end
|
|
|
|
obj_human_name = I18n.t(obj_hdl, :scope => 'objects', :default => "Object '#{obj_hdl}'")
|
|
name = item.human_name
|
|
name += " [#{item.name}]" if $handles_opt
|
|
puts "=== #{obj_human_name}: #{name} ==="
|
|
|
|
if $debug_opt
|
|
puts item.to_s
|
|
puts "--- Detected Info ---"
|
|
puts "aspects: " + item.aspects.sort.join(", ")
|
|
|
|
puts "--- Family ---"
|
|
puts "parent: " + item.family_parent_dn.to_s
|
|
puts "siblings: " + item.family_siblings_dn.join(", ")
|
|
puts "children: " + item.family_children_dn.join(", ")
|
|
|
|
puts "--- Relations ---"
|
|
item.relations.each do |rel|
|
|
puts "#{rel}: " + item.send(rel).collect{|g| g.name }.join(", ")
|
|
end
|
|
else
|
|
obj_info, obj_aspects = item.organized_data(:expert => $expert_opt, :skip_binary => true)
|
|
|
|
display_data(obj_info)
|
|
|
|
obj_aspects.each_pair do |aspect_name, aspect_data|
|
|
aspect_display_name = I18n.t(aspect_name, :scope => 'aspects', :default => "Aspect '#{aspect_name}'")
|
|
puts "--- #{aspect_display_name} ---"
|
|
display_data(aspect_data)
|
|
end
|
|
end
|
|
end
|
|
cmdparser.add_command(cmd)
|
|
|
|
cmdparser.parse
|