activeldap3 1.2.3

data/examples/al-admin/Rakefile

@@ -0,0 +1,16 @@
+# Add your own tasks in files placed in lib/tasks ending in .rake,
+# for example lib/tasks/capistrano.rake, and they will automatically be available to Rake.
+
+require(File.join(File.dirname(__FILE__), 'config', 'boot'))
+
+require 'rake'
+require 'rake/testtask'
+require 'rake/rdoctask'
+
+begin
+  require "gettext_i18n_rails/tasks"
+rescue LoadError
+  puts "gettext_i18n_rails is not installed, you probably should run 'rake gems:install'."
+end
+
+require 'tasks/rails'

data/examples/al-admin/app/controllers/account_controller.rb

@@ -0,0 +1,60 @@
+class AccountController < ApplicationController
+  before_filter :force_logout, :only => [:sign_up, :login, :logout]
+
+  def index
+    if logged_in?
+      redirect_to(top_path)
+    else
+      redirect_to(:action => 'login')
+    end
+  end
+
+  def login
+    return unless request.post?
+    self.current_user = User.authenticate(params[:login], params[:password])
+    if logged_in?
+      if params[:remember_me] == "1"
+        current_user.remember_me
+        cookies[:auth_token] = {
+          :value => current_user.remember_token,
+          :expires => current_user.remember_token_expires_at
+        }
+      end
+      redirect_back_or_default(top_url)
+      flash.now[:notice] = _("Logged in successfully")
+    else
+      flash.now[:notice] = _("Login or Password is incorrect")
+    end
+  end
+
+  def sign_up
+    @user = LdapUser.new(params[:user])
+    @required_attributes = @user.must.collect(&:name)
+    return unless request.post?
+
+    if @user.save
+      @system_user = User.create(:login => @user.id)
+      unless @system_user.new_record?
+        self.current_user = @system_user
+        redirect_back_or_default(top_path)
+        flash[:notice] = _("Thanks for signing up!")
+      end
+    end
+    @user.password = @user.password_confirmation = nil
+  end
+
+  def logout
+    flash[:notice] = _("You have been logged out.")
+    redirect_back_or_default(top_path)
+  end
+
+  private
+  def force_logout
+    return true unless logged_in?
+    current_user.forget_me
+    self.current_user = nil
+    cookies.delete :auth_token
+    reset_session
+    true
+  end
+end

data/examples/al-admin/app/controllers/application_controller.rb

@@ -0,0 +1,46 @@
+# Filters added to this controller apply to all controllers in the application.
+# Likewise, all the methods added will be available for all controllers.
+
+class ApplicationController < ActionController::Base
+  helper :all # include all helpers, all the time
+
+  # See ActionController::RequestForgeryProtection for details
+  # Uncomment the :secret if you're not using the cookie session store
+  protect_from_forgery # :secret => '5965eefc93d824a9c145fe8edb6d1a36'
+
+  include ExceptionNotifiable
+
+  include AuthenticatedSystem
+
+  before_filter :login_from_cookie
+
+  before_filter :set_gettext_locale
+
+  filter_parameter_logging :password, :password_confirmation
+
+  private
+  def default_url_options(options)
+    default_options = {}
+    lang = params["lang"]
+    default_options["lang"] = lang if lang
+    default_options.merge(options)
+  end
+
+  def current_ldap_user
+    logged_in? ? current_user.ldap_user : nil
+  end
+
+  def schema
+    @schema ||= current_ldap_user.schema
+  end
+
+  def authorized?
+    current_ldap_user.connected?
+  end
+
+  def set_gettext_locale
+    FastGettext.text_domain= 'al-admin'
+    FastGettext.available_locales = ['en','ja','nl']
+    super
+  end
+end

data/examples/al-admin/app/controllers/attributes_controller.rb

@@ -0,0 +1,17 @@
+class AttributesController < ApplicationController
+  before_filter :login_required
+
+  def index
+    @attributes = schema.attributes
+  end
+
+  def show
+    key = params[:id].to_a.flatten.compact[0]
+    raise ActiveRecord::RecordNotFound if key.nil?
+    @attribute = schema.attributes.find do |attribute|
+      attribute.name == key or
+        attribute.id == key
+    end
+    raise ActiveRecord::RecordNotFound if @attribute.nil?
+  end
+end

data/examples/al-admin/app/controllers/directory_controller.rb

@@ -0,0 +1,49 @@
+class DirectoryController < ApplicationController
+  before_filter :login_required, :except => [:populate]
+  before_filter :empty_entries_required, :only => [:populate]
+
+  verify :xhr => true, :only => [:entry],
+         :render => {:text => "Bad Request", :status => 400}
+
+  def index
+    @root = Entry.root(find_options)
+  end
+
+  def entry
+    dn = params[:dn]
+    if Entry.base == dn
+      @entry = Entry.root(find_options)
+    else
+      @entry = Entry.find(dn, find_options)
+    end
+    erb = "<%= render(:partial => '_entry/entry', :object => @entry) %>"
+    erb = "<div>\n#{erb}\n</div>"
+    render(:inline => erb)
+  end
+
+  def populate
+    ActiveLdap::Populate.ensure_base
+    ActiveLdap::Populate.ensure_ou(LdapUser.prefix)
+  end
+
+  private
+  def empty_entries_required
+    return true if Entry.empty?
+
+    flash.now[:notice] = _("Populating is only for initialization")
+    redirect_to(top_url)
+    false
+  end
+
+  def find_options
+    {:connection => current_ldap_user.connection}
+  end
+
+  def access_denied
+    if action_name == "entry"
+      render(:text => "Unauthorized", :status => 401)
+    else
+      super
+    end
+  end
+end

data/examples/al-admin/app/controllers/object_classes_controller.rb

@@ -0,0 +1,17 @@
+class ObjectClassesController < ApplicationController
+  before_filter :login_required
+
+  def index
+    @object_classes = schema.object_classes
+  end
+
+  def show
+    key = params[:id].to_a.flatten.compact[0]
+    raise ActiveRecord::RecordNotFound if key.nil?
+    @object_class = schema.object_classes.find do |object_class|
+      object_class.name == key or
+        object_class.id == key
+    end
+    raise ActiveRecord::RecordNotFound if @object_class.nil?
+  end
+end

data/examples/al-admin/app/controllers/syntaxes_controller.rb

@@ -0,0 +1,17 @@
+class SyntaxesController < ApplicationController
+  before_filter :login_required
+
+  def index
+    @syntaxes = schema.ldap_syntaxes
+  end
+
+  def show
+    key = params[:id].to_a.flatten.compact[0]
+    raise ActiveRecord::RecordNotFound if key.nil?
+    @syntax = schema.ldap_syntaxes.find do |syntax|
+      syntax.name == key or
+        syntax.id == key
+    end
+    raise ActiveRecord::RecordNotFound if @syntax.nil?
+  end
+end

data/examples/al-admin/app/controllers/users_controller.rb

@@ -0,0 +1,66 @@
+class UsersController < ApplicationController
+  verify :method => :post, :only => [:update],
+         :redirect_to => {:action => :index}
+
+  before_filter :login_required
+
+  def index
+    @users = find(:all)
+  end
+
+  def show
+    @user = find(params[:id])
+  end
+
+  def edit
+    @user = find(params[:id])
+  end
+
+  def update
+    @user = find(params[:id])
+    previous_user_password = @user.user_password
+    object_class_error_message = nil
+    begin
+      @user.replace_class(params["object-classes"])
+    rescue ActiveLdap::RequiredObjectClassMissed
+      object_class_error_message = $!.message
+    end
+    if @user.update_attributes(params[:user]) and
+        object_class_error_message.nil?
+      if previous_user_password != @user.user_password and @user.connected?
+        @user.bind(@user.password)
+      end
+      flash[:notice] = _('User was successfully updated.')
+      redirect_to :action => 'show', :id => @user
+    else
+      @user.password = @user.password_confirmation = nil
+      @user.errors.add("objectClass", object_class_error_message)
+      render :action => 'edit'
+    end
+  end
+
+  def update_object_classes
+    @user = find(params[:id])
+    begin
+      @user.replace_class(params["object-classes"])
+    rescue ActiveLdap::RequiredObjectClassMissed
+      flash.now[:inline_notice] = $!.message
+      erb = "<%= flash_box(flash[:inline_notice], :need_container => true) %>"
+      render(:inline => erb, :status => 400)
+      return
+    end
+    available_attributes = @user.attribute_names(true)
+    attributes = {}
+    (params[:user] || {}).each do |key, value|
+      attributes[key] = value if available_attributes.include?(key)
+    end
+    @user.attributes = attributes
+    erb = "<div>\n<%= render(:partial => 'attributes_update_form') %>\n</div>"
+    render(:inline => erb)
+  end
+
+  private
+  def find(*args)
+    current_ldap_user.find(*args)
+  end
+end

data/examples/al-admin/app/controllers/welcome_controller.rb

@@ -0,0 +1,12 @@
+class WelcomeController < ApplicationController
+  include UrlHelper
+
+  def index
+    if Entry.empty?
+      redirect_to(populate_path)
+    elsif !logged_in?
+      flash.keep(:notice)
+      redirect_to(login_path)
+    end
+  end
+end

data/examples/al-admin/app/helpers/account_helper.rb

@@ -0,0 +1,2 @@
+module AccountHelper
+end

data/examples/al-admin/app/helpers/application_helper.rb

@@ -0,0 +1,46 @@
+# Methods added to this helper will be available to all templates in the application.
+module ApplicationHelper
+  include UrlHelper
+
+  def flash_box(message, options={})
+    return '' if message.nil?
+    id = "flash-box"
+    fade_out = Proc.new {|page| page.visual_effect(:fade, id)}
+    message = content_tag(:p, h(message), :class => "notice")
+    flash_box_div = content_tag("div", "\n#{message}\n",
+                                :id => id,
+                                :onclick => update_page(&fade_out))
+    if options[:need_container]
+      flash_box_div = content_tag("div", "\n  #{flash_box_div}\n",
+                                  :class => "flash-box-container")
+    end
+    set_opacity = update_page {|page| page[id].setOpacity("0.8")}
+    effect = update_page do |page|
+      page.delay(5) do
+        fade_out.call(page)
+      end
+    end
+    javascript_content = "#{set_opacity}\n#{effect}"
+    "#{flash_box_div}\n#{javascript_tag(javascript_content)}"
+  end
+
+  def switcher(prefix, title, options={})
+    concat(render(:partial => "_switcher/before",
+                  :locals => {:prefix => prefix, :title => title}))
+    yield
+    concat(render(:partial => "_switcher/after",
+                  :locals => {:prefix => prefix, :options => options}))
+  end
+
+  def switcher_element(prefix, options={})
+    options[:open] = true unless options.has_key?(:open)
+    switch_id = "#{prefix}-switch".to_json
+    content_id = "#{prefix}-content".to_json
+    options = options_for_javascript(options)
+    javascript_tag("new Switcher(#{switch_id}, #{content_id}, #{options});")
+  end
+
+  def boolean_value(condition)
+    condition ? "o" : "x"
+  end
+end

data/examples/al-admin/app/helpers/attributes_helper.rb

@@ -0,0 +1,15 @@
+module AttributesHelper
+  include SyntaxesHelper
+
+  def attribute_url_for_options(attribute)
+    {
+      :controller => "attributes",
+      :action => "show",
+      :id => attribute
+    }
+  end
+
+  def link_to_attribute(attribute)
+    link_to(h(la_(attribute)), attribute_url_for_options(attribute))
+  end
+end

data/examples/al-admin/app/helpers/directory_helper.rb

@@ -0,0 +1,7 @@
+module DirectoryHelper
+  include ObjectClassesHelper
+
+  def failed_to_retrieve_entry_message
+    content_tag(:h2, _("Failed to retrieve the entry"))
+  end
+end

data/examples/al-admin/app/helpers/object_classes_helper.rb

@@ -0,0 +1,10 @@
+module ObjectClassesHelper
+  include AttributesHelper
+
+  def link_to_object_class(object_class)
+    link_to(h(loc_(object_class)),
+            :controller => "object_classes",
+            :action => "show",
+            :id => object_class)
+  end
+end

data/examples/al-admin/app/helpers/syntaxes_helper.rb

@@ -0,0 +1,10 @@
+module SyntaxesHelper
+  def link_to_syntax(syntax)
+    label = h(ls_(syntax))
+    label << "{#{syntax.length}}" if syntax.length
+    link_to(label,
+            :controller => "syntaxes",
+            :action => "show",
+            :id => syntax)
+  end
+end

data/examples/al-admin/app/helpers/url_helper.rb

@@ -0,0 +1,17 @@
+module UrlHelper
+  def login_path
+    url_for(:controller => "/account", :action => "login")
+  end
+
+  def logout_path
+    url_for(:controller => "/account", :action => "logout")
+  end
+
+  def sign_up_path
+    url_for(:controller => "/account", :action => "sign_up")
+  end
+
+  def populate_path
+    url_for(:controller => "/directory", :action => "populate")
+  end
+end

data/examples/al-admin/app/helpers/users_helper.rb

@@ -0,0 +1,17 @@
+module UsersHelper
+  include ObjectClassesHelper
+
+  def user_link(user, with_edit=false)
+    user_link_if(true, user, with_edit)
+  end
+
+  def user_link_if(condition, user, with_edit=false)
+    result = link_to_if(condition, h(user.short_dn),
+                        :action => "show", :id => user)
+    if with_edit and current_user and current_user.ldap_user == user
+      edit_link = link_to(_('Edit'), :action => 'edit', :id => user)
+      result << "\n(" << edit_link << ")"
+    end
+    result
+  end
+end