activeldap 0.9.0

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,42 @@
+# Methods added to this helper will be available to all templates in the application.
+module ApplicationHelper
+  include UrlHelper
+
+  def flash_box(message)
+    id = "flash-box"
+    fade_out = Proc.new {|page| page.visual_effect(:fade, id)}
+    flash_box_div = content_tag("div", "\n#{message}\n",
+                                :id => id,
+                                :onclick => update_page(&fade_out))
+    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={}, &proc)
+    concat(render(:partial => "_switcher/before",
+                  :locals => {:prefix => prefix, :title => title}),
+           proc.binding)
+    yield
+    concat(render(:partial => "_switcher/after",
+                  :locals => {:prefix => prefix, :options => options}),
+           proc.binding)
+  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,13 @@
+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
+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

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

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

data/examples/al-admin/app/models/entry.rb

@@ -0,0 +1,23 @@
+class Entry < ActiveLdap::Base
+  ldap_mapping :prefix => "",
+               :classes => ["top"],
+               :scope => :sub
+  self.dn_attribute = nil
+
+  validate :always_fail
+
+  class << self
+    def empty?
+      search(:scope => :base).empty?
+    end
+  end
+
+  def short_dn
+    @short_dn ||= dn == base ? dn : "#{dn_attribute}=#{id}"
+  end
+
+  private
+  def always_fail
+    errors.add("save", _("disable saving"))
+  end
+end

data/examples/al-admin/app/models/ldap_user.rb

@@ -0,0 +1,54 @@
+require 'active_ldap/user_password'
+
+class LdapUser < ActiveLdap::Base
+  ldap_mapping :prefix => "ou=Users",
+               :classes => ["person"],
+               :dn_attribute => "cn"
+
+  N_("LdapUser|Password")
+  N_("LdapUser|Password confirmation")
+  attr_accessor :password
+
+  validates_presence_of :password, :password_confirmation,
+                        :if => :password_required?
+  validates_length_of :password, :within => 4..40,
+                      :if => :password_required?
+  validates_confirmation_of :password, :if => :password_required?
+  before_save :encrypt_password
+
+  class << self
+    def authenticate(dn, password)
+      user = find(dn)
+      user.authenticated?(password) ? user : nil
+    rescue ActiveLdap::EntryNotFound
+      nil
+    end
+  end
+
+  def authenticated?(password)
+    bind(password)
+    true
+  rescue ActiveLdap::AuthenticationError,
+      ActiveLdap::LdapError::UnwillingToPerform
+    false
+  end
+
+  def short_dn
+    @short_dn ||=
+      (ActiveLdap::DN.parse(dn) - ActiveLdap::DN.parse(self.class.base)).to_s
+  end
+
+  private
+  def encrypt_password
+    return if password.blank?
+    hash_type = "ssha"
+    if /\A\{([A-Z][A-Z\d]+)\}/ =~ userPassword.to_s
+      hash_type = $1.downcase
+    end
+    self.user_password = ActiveLdap::UserPassword.send(hash_type, password)
+  end
+
+  def password_required?
+    user_password.blank? or !password.blank?
+  end
+end

data/examples/al-admin/app/models/user.rb

@@ -0,0 +1,91 @@
+require 'digest/sha1'
+
+class User < ActiveRecord::Base
+  validates_presence_of     :login
+  validates_presence_of     :dn
+  validates_uniqueness_of   :login, :dn, :case_sensitive => false
+  before_validation :generate_salt, :find_dn
+
+  class << self
+    def authenticate(login, password)
+      u = find_by_login(login) # need to get the salt
+      if u.nil?
+        u = new
+        u.login = login
+        u = nil unless u.save
+      end
+      u && u.authenticated?(password) ? u : nil
+    end
+
+    def encrypt(password, salt)
+      Digest::SHA1.hexdigest("--#{salt}--#{password}--")
+    end
+  end
+
+  def encrypt(password)
+    self.class.encrypt(password, salt)
+  end
+
+  def authenticated?(password)
+    return false if ldap_user.nil? or ldap_user.new_entry?
+    ldap_user.authenticated?(password)
+  end
+
+  def ldap_user
+    @ldap_user ||= LdapUser.find(dn)
+  rescue ActiveLdap::EntryNotFound
+    if dn
+      LdapUser.new(dn)
+    else
+      nil
+    end
+  end
+
+  def remember_token?
+    begin
+      remember_token_expires_at and
+        Time.now.utc < remember_token_expires_at and
+        ldap_user.connected?
+    rescue ActiveLdap::EntryNotFound
+      false
+    end
+  end
+
+  # These create and unset the fields required for remembering users between browser closes
+  def remember_me
+    self.remember_token_expires_at = 2.weeks.from_now.utc
+    self.remember_token = encrypt("#{dn}--#{remember_token_expires_at}")
+    save(false)
+  end
+
+  def forget_me
+    self.remember_token_expires_at = nil
+    self.remember_token            = nil
+    save(false)
+    LdapUser.remove_connection(dn) if dn
+    @ldap_user = nil
+  end
+
+  def short_dn
+    ldap_user.short_dn
+  end
+
+  private
+  def generate_salt
+    return unless new_record?
+    self.salt = Digest::SHA1.hexdigest("--#{Time.now.to_s}--#{login}--")
+  end
+
+  def find_dn
+    if login.blank?
+      self.dn = nil
+    else
+      begin
+        ldap_user = LdapUser.find(login)
+        self.dn = ldap_user.dn
+      rescue ActiveLdap::EntryNotFound
+        self.dn = nil
+      end
+    end
+  end
+end

data/examples/al-admin/app/views/_entry/_attributes_information.rhtml

@@ -0,0 +1,23 @@
+
+<div class="attributes">
+  <table class="values">
+    <thead>
+      <tr>
+	<th><%= _("Attribute name") %></th>
+	<th><%= _("Value") %></th>
+	<th><%= _("Description") %></th>
+      </tr>
+    </thead>
+
+    <tbody>
+<% (entry.attribute_names(true) - ["objectClass"]).sort.each do |name| -%>
+      <tr class="<%= cycle('even', 'odd') %>">
+	<th scope="row"><%= link_to_attribute(name) %></th>
+	<td><%= h(entry[name, true].join(", ")) %></td>
+	<td><%= h(lad_(name)) %></td>
+      </tr>
+<% end -%>
+    </tbody>
+  </table>
+</div>
+<% reset_cycle %>

data/examples/al-admin/app/views/_entry/_entry.rhtml

@@ -0,0 +1,15 @@
+<% title ||= h(entry.short_dn) %>
+<div class="entry detail">
+  <h2><%= title %></h2>
+  <span class="full-identifier"><%= h(entry.dn) %></span>
+
+  <% switcher("object-classes", _("objectClasses")) do %>
+    <%= render(:partial => "object_classes/object_classes",
+	       :object => entry.classes) %>
+  <% end %>
+
+  <% switcher("attributes", _("Attributes")) do %>
+    <%= render(:partial => "_entry/attributes_information",
+	       :locals => {:entry => entry}) %>
+  <% end %>
+</div>

data/examples/al-admin/app/views/_schema/_aliases.rhtml

@@ -0,0 +1,7 @@
+
+<h3><%= _("Aliases") %></h3>
+<ul>
+<% aliases.uniq.sort.each do |alias_name| -%>
+  <li><%= h(alias_name) %></li>
+<% end -%>
+</ul>

data/examples/al-admin/app/views/_switcher/_after.rhtml

@@ -0,0 +1,2 @@
+</div>
+<%= switcher_element(prefix, options) %>

data/examples/al-admin/app/views/_switcher/_before.rhtml

@@ -0,0 +1,5 @@
+<h3>
+  <span id="<%= prefix %>-switch" class="switch"></span>
+  <%= title %>
+</h3>
+<div id="<%= prefix %>-content" class="switcher-content">

data/examples/al-admin/app/views/account/login.rhtml

@@ -0,0 +1,26 @@
+<div class="login-form">
+  <% form_tag do %>
+    <table>
+      <tr>
+        <th><label for="login"><%= _("Login:") %></label></th>
+        <td><%= text_field_tag 'login' %></td>
+      </tr>
+
+      <tr>
+        <th><label for="password"><%= _("Password:") %></th>
+        <td><%= password_field_tag 'password' %></td>
+      </tr>
+
+      <tr>
+        <td colspan="2">
+          <label for="remember_me"><%= _("Remember me:") %></label>
+          <%= check_box_tag 'remember_me' %>
+        </td>
+      </tr>
+    </table>
+
+    <p class="submit"><%= submit_tag(_('Log in')) %></p>
+  <% end %>
+</div>
+
+<%= javascript_tag("$('login').focus();") %>

data/examples/al-admin/app/views/account/sign_up.rhtml

@@ -0,0 +1,28 @@
+<%= error_messages_for(:user) %>
+<%= error_messages_for(:system_user) %>
+<% form_for(:user) do |f| %>
+  <p><label for="<%= @user.dn_attribute %>"><%= _("Login") %></label><br/>
+  <%= f.text_field(@user.dn_attribute) %></p>
+
+  <p><label for="password"><%= _("Password") %></label><br/>
+  <%= f.password_field(:password) %></p>
+
+  <p><label for="password_confirmation"><%= _("Confirm Password") %></label><br/>
+  <%= f.password_field(:password_confirmation) %></p>
+
+  <p><%= submit_tag(_('Sign up')) %></p>
+
+  <% names = @user.attribute_names(true) - ["objectClass", "userPassword"] %>
+  <% names.sort.each do |name| %>
+    <p>
+      <label for="<%= h name %>"><%=h la_(name) %>
+    <% if @required_attributes.include?(name) %>
+      <span class="required-attribute-mark">*</span>
+    <% end %>
+      <br />
+      <%= f.text_field(name) %>
+    </p>
+  <% end -%>
+
+  <p><%= submit_tag(_('Sign up')) %></p>
+<% end -%>

data/examples/al-admin/app/views/attributes/_attributes.rhtml

@@ -0,0 +1,19 @@
+
+<table class="values">
+  <thead>
+    <tr>
+      <th><%= _("Attribute name") %></th>
+      <th><%= _("Description") %></th>
+    </tr>
+  </thead>
+
+  <tbody>
+<% attributes.uniq.sort.each do |attribute| -%>
+    <tr class="<%= cycle('even', 'odd') %>">
+      <td><%= link_to_attribute(attribute) %></td>
+      <td><%= h(lad_(attribute)) %></td>
+    </tr>
+<% end -%>
+  </tbody>
+</table>
+<% reset_cycle %>

data/examples/al-admin/app/views/attributes/_detail.rhtml

@@ -0,0 +1,29 @@
+<table class="values">
+  <tbody>
+    <tr class="<%= cycle('even', 'odd') %>">
+      <th scope="row"><%= _("Read only") %></th>
+      <td><%= boolean_value(attribute.read_only?) %></td>
+    </tr>
+
+    <tr class="<%= cycle('even', 'odd') %>">
+      <th scope="row"><%= _("Single value") %></th>
+      <td><%= boolean_value(attribute.single_value?) %></td>
+    </tr>
+
+    <tr class="<%= cycle('even', 'odd') %>">
+      <th scope="row"><%= _("Binary") %></th>
+      <td><%= boolean_value(attribute.binary?) %></td>
+    </tr>
+
+    <tr class="<%= cycle('even', 'odd') %>">
+      <th scope="row"><%= _("Binary required") %></th>
+      <td><%= boolean_value(attribute.binary_required?) %></td>
+    </tr>
+
+    <tr class="<%= cycle('even', 'odd') %>">
+      <th scope="row"><%= _("Syntax") %></th>
+      <td><%= link_to_syntax(attribute.syntax) %></td>
+    </tr>
+  </tbody>
+</table>
+<% reset_cycle %>

data/examples/al-admin/app/views/attributes/index.rhtml

@@ -0,0 +1,3 @@
+<h2><%= _("Attribute list") %></h2>
+
+<%= render(:partial => "attributes", :object => @attributes) %>

data/examples/al-admin/app/views/attributes/show.rhtml

@@ -0,0 +1,31 @@
+
+<div class="attribute detail">
+  <h2><%= h(la_(@attribute)) %></h2>
+  <span class="full-identifier"><%= h(@attribute.id) %></span>
+
+  <h3><%= _("Description") %></h3>
+  <p class="description"><%= h(lad_(@attribute)) %></p>
+
+<% unless @attribute.aliases.empty? -%>
+  <%= render(:partial => "_schema/aliases", :object => @attribute.aliases) %>
+<% end -%>
+
+<% if @attribute.super_attribute -%>
+  <h3><%= _("Super attribute") %></h3>
+  <p class="super-attribute">
+    <%= link_to(h(la_(@attribute.super_attribute)),
+                :action => "show",
+                :id => @attribute.super_attribute) %>
+  </p>
+<% end -%>
+
+  <% switcher("attribute-detail", _("Detail")) do %>
+    <%= render(:partial => "detail", :locals => {:attribute => @attribute}) %>
+  <% end %>
+</div>
+
+<div class="navi">
+  <ul>
+    <li><%= link_to s_('Menu|Index'), :action => 'index' %></li>
+  </ul>
+</div>

data/examples/al-admin/app/views/directory/_tree.rhtml

@@ -0,0 +1,10 @@
+<% have_child = !tree.children.empty? %>
+<li class="<%= have_child ? 'dir' : 'file' %>">
+  <span class="node-dn"><%= h(tree.dn) %></span>
+  <span class="node-short-dn"><%= h(tree.short_dn) %></span>
+<% if have_child -%>
+  <ul>
+    <%= render(:partial => "tree", :collection => tree.children) %>
+  </ul>
+<% end -%>
+</li>

data/examples/al-admin/app/views/directory/_tree_view_js.rhtml

@@ -0,0 +1,26 @@
+<%# -*- javascript -*- %>
+var treeView = new TreeView(<%= tree_id.to_json %>,
+                            {
+                              move: false,
+                              emptyImg: true,
+                              open: true
+                            });
+
+treeView.addSelectItemCallback(function (element)
+{
+  var selectedNode = element.getElementsByClassName('node-dn')[0];
+  var selectedDN = selectedNode.childNodes[0].nodeValue;
+  var failureHandler = function(transport, json)
+  {
+    var message = <%= failed_to_retrieve_entry_message.to_json %> + "\n";
+    message += '<span class="dn">' + selectedDN + "</span>\n";
+    message = "<div class=\"entry\">\n" + message + "</div>";
+    $(<%= entry_id.to_json %>).update(message);
+  }
+
+  new Ajax.Updater({success: <%= entry_id.to_json %>},
+                   <%= url_for(:action => "entry").to_json %>,
+                   {parameters: {dn: selectedDN},
+                    evalScripts: true,
+                    onFailure: failureHandler});
+});

data/examples/al-admin/app/views/directory/index.rhtml

@@ -0,0 +1,13 @@
+<ul id="directory-tree">
+  <%= render(:partial => "tree", :object => @root) %>
+</ul>
+
+<div id="entry-information">
+  <%= render(:partial => "_entry/entry", :object => @root) %>
+</div>
+
+<%= javascript_tag(render(:partial => "tree_view_js",
+                          :locals => {:tree_id => "directory-tree",
+                                      :entry_id => "entry-information"})) %>
+
+<hr class="clear" />

data/examples/al-admin/app/views/directory/populate.rhtml

@@ -0,0 +1,2 @@
+<p><%= _("Done.") %></p>
+<p><%= link_to(s_("Menu|Index"), :action => "index") %></p>

data/examples/al-admin/app/views/layouts/_flash_box.rhtml

@@ -0,0 +1,4 @@
+
+<% if flash[:notice] -%>
+  <%= flash_box(content_tag(:p, h(flash[:notice]), :class => "notice")) %>
+<% end -%>

data/examples/al-admin/app/views/layouts/_footer.rhtml

@@ -0,0 +1,9 @@
+
+<div class="system-info">
+  <address>
+    al-admin: Powered by
+    <%= link_to("Ruby/ActiveLdap",
+		"http://rubyforge.org/projects/ruby-activeldap") %>
+    <%= ActiveLdap::VERSION %>
+  </address>
+</div>

data/examples/al-admin/app/views/layouts/_header_menu.rhtml

@@ -0,0 +1,10 @@
+
+<ul>
+<% if logged_in? -%>
+  <li><span class="myself"><%= h(current_user.short_dn) %></span></li>
+  <li><%= link_to(s_("Menu|Logout"), logout_path) %></li>
+<% else -%>
+  <li><%= link_to(s_("Menu|Login"), login_path) %></li>
+<% end -%>
+  <li><%= link_to(s_("Menu|Sign up"), sign_up_path) %></li>
+</ul>

data/examples/al-admin/app/views/layouts/_main_menu.rhtml

@@ -0,0 +1,18 @@
+
+<% if logged_in? -%>
+  <div class="main-menu">
+    <ul>
+<% [
+    [s_("Menu|Users list"), {:controller => "users"}],
+    [s_("Menu|Directory"), {:controller => "directory"}],
+    [s_("Menu|objectClass list"), {:controller => "object_classes"}],
+    [s_("Menu|Attribute list"), {:controller => "attributes"}],
+    [s_("Menu|Syntax list"), {:controller => "syntaxes"}],
+   ].each do |label, options| -%>
+      <li <%= current_page?(options) ? 'class="current-page"' : "" %>>
+        <%= link_to(label, options) %>
+      </li>
+<% end -%>
+    </ul>
+  </div>
+<% end -%>