ruby-activeldap 0.8.3 → 0.8.3.1

data/examples/al-admin/vendor/plugins/exception_notification/lib/exception_notifier.rb

@@ -0,0 +1,67 @@
+require 'pathname'
+
+# Copyright (c) 2005 Jamis Buck
+#
+# Permission is hereby granted, free of charge, to any person obtaining
+# a copy of this software and associated documentation files (the
+# "Software"), to deal in the Software without restriction, including
+# without limitation the rights to use, copy, modify, merge, publish,
+# distribute, sublicense, and/or sell copies of the Software, and to
+# permit persons to whom the Software is furnished to do so, subject to
+# the following conditions:
+#
+# The above copyright notice and this permission notice shall be
+# included in all copies or substantial portions of the Software.
+#
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+# EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+# MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+# NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+# LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+# OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+# WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+class ExceptionNotifier < ActionMailer::Base
+  @@sender_address = %("Exception Notifier" <exception.notifier@default.com>)
+  cattr_accessor :sender_address
+
+  @@exception_recipients = []
+  cattr_accessor :exception_recipients
+
+  @@email_prefix = "[ERROR] "
+  cattr_accessor :email_prefix
+
+  @@sections = %w(request session environment backtrace)
+  cattr_accessor :sections
+
+  def self.reloadable?; false; end
+
+  def exception_notification(exception, controller, request, data={})
+    subject    "#{email_prefix}#{controller.controller_name}##{controller.action_name} (#{exception.class}) #{exception.message.inspect}"
+
+    recipients exception_recipients
+    from       sender_address
+
+    body       data.merge({ :controller => controller, :request => request,
+                  :exception => exception, :host => request.env["HTTP_HOST"],
+                  :backtrace => sanitize_backtrace(exception.backtrace),
+                  :rails_root => rails_root, :data => data,
+                  :sections => sections })
+  end
+
+  def template_root
+    "#{File.dirname(__FILE__)}/../views"
+  end
+
+  private
+
+    def sanitize_backtrace(trace)
+      re = Regexp.new(/^#{Regexp.escape(rails_root)}/)
+      trace.map { |line| Pathname.new(line.gsub(re, "[RAILS_ROOT]")).cleanpath.to_s }
+    end
+
+    def rails_root
+      return @rails_root if @rails_root
+      @rails_root = Pathname.new(RAILS_ROOT).cleanpath.to_s
+    end
+
+end

data/examples/al-admin/vendor/plugins/exception_notification/lib/exception_notifier_helper.rb

@@ -0,0 +1,77 @@
+require 'pp'
+
+# Copyright (c) 2005 Jamis Buck
+#
+# Permission is hereby granted, free of charge, to any person obtaining
+# a copy of this software and associated documentation files (the
+# "Software"), to deal in the Software without restriction, including
+# without limitation the rights to use, copy, modify, merge, publish,
+# distribute, sublicense, and/or sell copies of the Software, and to
+# permit persons to whom the Software is furnished to do so, subject to
+# the following conditions:
+#
+# The above copyright notice and this permission notice shall be
+# included in all copies or substantial portions of the Software.
+#
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+# EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+# MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+# NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+# LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+# OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+# WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+module ExceptionNotifierHelper
+  VIEW_PATH = "views/exception_notifier"
+  APP_PATH = "#{RAILS_ROOT}/app/#{VIEW_PATH}"
+  PARAM_FILTER_REPLACEMENT = "[FILTERED]"
+
+  def render_section(section)
+    RAILS_DEFAULT_LOGGER.info("rendering section #{section.inspect}")
+    summary = render_overridable(section).strip
+    unless summary.blank?
+      title = render_overridable(:title, :locals => { :title => section }).strip
+      "#{title}\n\n#{summary.gsub(/^/, "  ")}\n\n"
+    end
+  end
+
+  def render_overridable(partial, options={})
+    if File.exist?(path = "#{APP_PATH}/_#{partial}.rhtml")
+      render(options.merge(:file => path, :use_full_path => false))
+    elsif File.exist?(path = "#{File.dirname(__FILE__)}/../#{VIEW_PATH}/_#{partial}.rhtml")
+      render(options.merge(:file => path, :use_full_path => false))
+    else
+      ""
+    end
+  end
+
+  def inspect_model_object(model, locals={})
+    render_overridable(:inspect_model,
+      :locals => { :inspect_model => model,
+                   :show_instance_variables => true,
+                   :show_attributes => true }.merge(locals))
+  end
+
+  def inspect_value(value)
+    len = 512
+    result = object_to_yaml(value).gsub(/\n/, "\n  ").strip
+    result = result[0,len] + "... (#{result.length-len} bytes more)" if result.length > len+20
+    result
+  end
+
+  def object_to_yaml(object)
+    object.to_yaml.sub(/^---\s*/m, "")
+  end
+
+  def exclude_raw_post_parameters?
+    @controller && @controller.respond_to?(:filter_parameters)
+  end
+  
+  def filter_sensitive_post_data_parameters(parameters)
+    exclude_raw_post_parameters? ? @controller.filter_parameters(parameters) : parameters
+  end
+  
+  def filter_sensitive_post_data_from_env(env_key, env_value)
+    return env_value unless exclude_raw_post_parameters?
+    (env_key =~ /RAW_POST_DATA/i) ? PARAM_FILTER_REPLACEMENT : env_value
+  end
+end

data/examples/al-admin/vendor/plugins/exception_notification/test/exception_notifier_helper_test.rb

@@ -0,0 +1,61 @@
+require 'test_helper'
+require 'exception_notifier_helper'
+
+class ExceptionNotifierHelperTest < Test::Unit::TestCase
+
+  class ExceptionNotifierHelperIncludeTarget
+    include ExceptionNotifierHelper
+  end
+
+  def setup
+    @helper = ExceptionNotifierHelperIncludeTarget.new
+  end
+
+  # No controller
+  
+  def test_should_not_exclude_raw_post_parameters_if_no_controller
+    assert !@helper.exclude_raw_post_parameters?
+  end
+  
+  # Controller, no filtering
+  
+  class ControllerWithoutFilterParameters; end
+
+  def test_should_not_filter_env_values_for_raw_post_data_keys_if_controller_can_not_filter_parameters
+    stub_controller(ControllerWithoutFilterParameters.new)
+    assert @helper.filter_sensitive_post_data_from_env("RAW_POST_DATA", "secret").include?("secret")
+  end
+  def test_should_not_exclude_raw_post_parameters_if_controller_can_not_filter_parameters
+    stub_controller(ControllerWithoutFilterParameters.new)
+    assert !@helper.exclude_raw_post_parameters?    
+  end
+  def test_should_return_params_if_controller_can_not_filter_parameters
+    stub_controller(ControllerWithoutFilterParameters.new)
+    assert_equal :params, @helper.filter_sensitive_post_data_parameters(:params)
+  end
+
+  # Controller with filtering
+
+  class ControllerWithFilterParameters
+    def filter_parameters(params); :filtered end
+  end
+
+  def test_should_filter_env_values_for_raw_post_data_keys_if_controller_can_filter_parameters
+    stub_controller(ControllerWithFilterParameters.new)
+    assert !@helper.filter_sensitive_post_data_from_env("RAW_POST_DATA", "secret").include?("secret")
+    assert @helper.filter_sensitive_post_data_from_env("SOME_OTHER_KEY", "secret").include?("secret")
+  end
+  def test_should_exclude_raw_post_parameters_if_controller_can_filter_parameters
+    stub_controller(ControllerWithFilterParameters.new)
+    assert @helper.exclude_raw_post_parameters?
+  end
+  def test_should_delegate_param_filtering_to_controller_if_controller_can_filter_parameters
+    stub_controller(ControllerWithFilterParameters.new)
+    assert_equal :filtered, @helper.filter_sensitive_post_data_parameters(:params)
+  end
+  
+  private
+    def stub_controller(controller)
+      @helper.instance_variable_set(:@controller, controller)
+    end
+end

data/examples/al-admin/vendor/plugins/exception_notification/test/test_helper.rb

@@ -0,0 +1,7 @@
+require 'test/unit'
+require 'rubygems'
+require 'active_support'
+
+$:.unshift File.join(File.dirname(__FILE__), '../lib')
+
+RAILS_ROOT = '.' unless defined?(RAILS_ROOT)

data/examples/al-admin/vendor/plugins/exception_notification/views/exception_notifier/_backtrace.rhtml

@@ -0,0 +1 @@
+<%= @backtrace.join "\n" %>

data/examples/al-admin/vendor/plugins/exception_notification/views/exception_notifier/_environment.rhtml

@@ -0,0 +1,7 @@
+<% max = @request.env.keys.max { |a,b| a.length <=> b.length } -%>
+<% @request.env.keys.sort.each do |key| -%>
+* <%= "%*-s: %s" % [max.length, key, filter_sensitive_post_data_from_env(key, @request.env[key].to_s.strip)] %>
+<% end -%>
+
+* Process: <%= $$ %>
+* Server : <%= `hostname -s`.chomp %>

data/examples/al-admin/vendor/plugins/exception_notification/views/exception_notifier/_inspect_model.rhtml

@@ -0,0 +1,16 @@
+<% if show_attributes -%>
+[attributes]
+<% attrs = inspect_model.attributes -%>
+<% max = attrs.keys.max { |a,b| a.length <=> b.length } -%>
+<% attrs.keys.sort.each do |attr| -%>
+* <%= "%*-s: %s" % [max.length, attr, object_to_yaml(attrs[attr]).gsub(/\n/, "\n  ").strip] %>
+<% end -%>
+<% end -%>
+
+<% if show_instance_variables -%>
+[instance variables]
+<% inspect_model.instance_variables.sort.each do |variable| -%>
+<%- next if variable == "@attributes" -%>
+* <%= variable %>: <%= inspect_value(inspect_model.instance_variable_get(variable)) %>
+<% end -%>
+<% end -%>

data/examples/al-admin/vendor/plugins/exception_notification/views/exception_notifier/_request.rhtml

@@ -0,0 +1,3 @@
+* URL: <%= @request.protocol %><%= @host %><%= @request.request_uri %>
+* Parameters: <%= filter_sensitive_post_data_parameters(@request.parameters).inspect %>
+* Rails root: <%= @rails_root %>

data/examples/al-admin/vendor/plugins/exception_notification/views/exception_notifier/_session.rhtml

@@ -0,0 +1,2 @@
+* session id: <%= @request.session.instance_variable_get(:@session_id).inspect %>
+* data: <%= PP.pp(@request.session.instance_variable_get(:@data),"").gsub(/\n/, "\n  ").strip %>

data/examples/al-admin/vendor/plugins/exception_notification/views/exception_notifier/_title.rhtml

@@ -0,0 +1,3 @@
+-------------------------------
+<%= title.to_s.humanize %>:
+-------------------------------

data/examples/al-admin/vendor/plugins/exception_notification/views/exception_notifier/exception_notification.rhtml

@@ -0,0 +1,6 @@
+A <%= @exception.class %> occurred in <%= @controller.controller_name %>#<%= @controller.action_name %>:
+
+  <%= @exception.message %>
+  <%= @backtrace.first %>
+
+<%= @sections.map { |section| render_section(section) }.join %>

data/examples/config.yaml.example

@@ -0,0 +1,5 @@
+host: 127.0.0.1
+method: :tls
+base: dc=localdomain
+bind_dn: cn=admin,dc=localdomain
+#adapter: net-ldap

data/examples/groupadd

@@ -0,0 +1,41 @@
+#!/usr/bin/ruby -W0
+
+base = File.expand_path(File.join(File.dirname(__FILE__), ".."))
+$LOAD_PATH << File.join(base, "lib")
+$LOAD_PATH << File.join(base, "examples")
+
+require 'active_ldap'
+require 'objects/user'
+require 'objects/group'
+
+argv, opts, options = ActiveLdap::Command.parse_options do |opts, options|
+  opts.banner += " GROUP_NAME"
+end
+
+if argv.size == 1
+  name = argv.shift
+else
+  $stderr.puts opts
+  exit 1
+end
+
+pwb = Proc.new do |user|
+  ActiveLdap::Command.read_password("[#{user}] Password: ")
+end
+
+ActiveLdap::Base.establish_connection(:password_block => pwb,
+                                      :allow_anonymous => false)
+
+if Group.exists?(name)
+  $stderr.puts("Group #{name} already exists.")
+  exit 1
+end
+
+group = Group.new(name)
+group.gid_number = 9000
+
+unless group.save
+  puts "failed"
+  puts group.errors.full_messages
+  exit 1
+end

data/examples/groupdel

@@ -0,0 +1,35 @@
+#!/usr/bin/ruby -W0
+
+base = File.expand_path(File.join(File.dirname(__FILE__), ".."))
+$LOAD_PATH << File.join(base, "lib")
+$LOAD_PATH << File.join(base, "examples")
+
+require 'active_ldap'
+require 'objects/user'
+require 'objects/group'
+
+argv, opts, options = ActiveLdap::Command.parse_options do |opts, options|
+  opts.banner += " GROUP_NAME"
+end
+
+if argv.size == 1
+  name = argv.shift
+else
+  $stderr.puts opts
+  exit 1
+end
+
+pwb = Proc.new do |user|
+  ActiveLdap::Command.read_password("[#{user}] Password: ")
+end
+
+ActiveLdap::Base.establish_connection(:password_block => pwb,
+                                      :allow_anonymous => false)
+
+
+unless Group.exists?(name)
+  $stderr.puts("Group #{name} doesn't exist.")
+  exit 1
+end
+
+Group.destroy(name)

data/examples/groupls

@@ -0,0 +1,49 @@
+#!/usr/bin/ruby -W0
+
+base = File.expand_path(File.join(File.dirname(__FILE__), ".."))
+$LOAD_PATH << File.join(base, "lib")
+$LOAD_PATH << File.join(base, "examples")
+
+require 'active_ldap'
+require 'objects/user'
+require 'objects/group'
+
+argv, opts, options = ActiveLdap::Command.parse_options do |opts, options|
+  opts.banner += " GROUP_NAME"
+end
+
+if argv.size == 1
+  name = argv.shift
+else
+  $stderr.puts opts
+  exit 1
+end
+
+pwb = Proc.new do |user|
+  ActiveLdap::Command.read_password("[#{user}] Password: ")
+end
+
+ActiveLdap::Base.establish_connection(:password_block => pwb,
+                                      :allow_anonymous => false)
+
+unless Group.exists?(name)
+  $stderr.puts("Group #{name} doesn't exist.")
+  exit 1
+end
+
+group = Group.find(name)
+
+members = []
+group.primary_members.each do |mem|
+  members << "#{mem.uid}[#{mem.uidNumber}]"
+end
+
+group.members.each do |mem|
+  if mem.new_entry?
+    members << "#{mem.uid}[????]"
+  else
+    members << "#{mem.uid}[#{mem.uidNumber}]"
+  end
+end
+
+puts("#{group.id}(#{group.gid_number}): #{members.join(', ')}")

data/examples/groupmod

@@ -0,0 +1,42 @@
+#!/usr/bin/ruby -W0
+
+base = File.expand_path(File.join(File.dirname(__FILE__), ".."))
+$LOAD_PATH << File.join(base, "lib")
+$LOAD_PATH << File.join(base, "examples")
+
+require 'active_ldap'
+require 'objects/user'
+require 'objects/group'
+
+argv, opts, options = ActiveLdap::Command.parse_options do |opts, options|
+  opts.banner += " GROUP_NAME GID_NUMBER"
+end
+
+if argv.size == 2
+  name, gid = argv
+else
+  $stderr.puts opts
+  exit 1
+end
+
+pwb = Proc.new do |user|
+  ActiveLdap::Command.read_password("[#{user}] Password: ")
+end
+
+ActiveLdap::Base.establish_connection(:password_block => pwb,
+                                      :allow_anonymous => false)
+
+
+unless Group.exists?(name)
+  $stderr.puts("Group #{name} doesn't exist.")
+  exit 1
+end
+
+group = Group.find(name)
+group.gid_number = gid
+
+unless group.save
+  puts "failed"
+  puts group.errors.full_messages
+  exit 1
+end