radiant-reader-extension 3.0.0.rc4 → 3.0.0

data/config/routes.rb

@@ -3,30 +3,39 @@ ActionController::Routing::Routes.draw do |map|
     admin.resources :messages, :member => [:preview, :deliver]
     admin.resources :groups, :has_many => [:memberships, :permissions, :group_invitations, :messages]
     admin.resource :reader_configuration, :controller => 'reader_configuration'
+    admin.toggle_group_membership "memberships/toggle", :controller => 'memberships', :action => 'toggle'
+    admin.toggle_group_permission "permissions/toggle", :controller => 'permissions', :action => 'toggle'
   end
 
   map.namespace :admin do |admin|
     admin.resources :readers, :except => [:show]
   end
 
-  map.resources :readers, :controller => 'accounts'
-  map.resources :messages, :only => [:index, :show], :member => [:preview]
-  map.resources :groups, :only => [:index, :show] do |group|
+  readers_prefix = Radiant.config['reader.profiles_path'] || "directory"
+
+  map.resources :readers, :controller => 'accounts', :path_prefix => readers_prefix
+  map.resources :messages, :only => [:index, :show], :member => [:preview], :path_prefix => readers_prefix
+  map.resources :groups, :path_prefix => readers_prefix do |group|
     group.resources :messages, :only => [:index, :show], :member => [:preview]
   end
 
-  map.resource :reader_session
-  map.resource :reader_activation, :only => [:show, :new]
-  map.resource :password_reset
+  accounts_prefix = Radiant.config['reader.preferences_path'] || "account"
+
+  map.resource :reader_session, :path_prefix => accounts_prefix
+  map.resource :reader_activation, :only => [:show, :new], :path_prefix => accounts_prefix
+  map.resource :password_reset, :path_prefix => accounts_prefix
+
+  map.activate_me "#{accounts_prefix}/activate/:id/:activation_code", :controller => 'reader_activations', :action => 'update'
+  map.repassword_me "#{accounts_prefix}/repassword/:id/:confirmation_code", :controller => 'password_resets', :action => 'edit'
+  map.reader_register "#{accounts_prefix}/register", :controller => 'accounts', :action => 'new'
+  map.reader_login "#{accounts_prefix}/login", :controller => 'reader_sessions', :action => 'new'
+  map.reader_logout "#{accounts_prefix}/logout", :controller => 'reader_sessions', :action => 'destroy'
+  map.reader_account "#{accounts_prefix}/preferences", :controller => 'accounts', :action => 'edit'
+  map.reader_profile "#{readers_prefix}/profile", :controller => 'accounts', :action => 'show'
+  map.reader_edit_profile "#{accounts_prefix}/edit_profile", :controller => 'accounts', :action => 'edit_profile'
+  map.reader_permission_denied "#{accounts_prefix}/permission_denied", :controller => 'accounts', :action => 'permission_denied'
   
-  map.activate_me '/activate/:id/:activation_code', :controller => 'reader_activations', :action => 'update'
-  map.repassword_me 'repassword/:id/:confirmation_code', :controller => 'password_resets', :action => 'edit'
-  map.reader_register '/register', :controller => 'accounts', :action => 'new'
-  map.reader_login '/login', :controller => 'reader_sessions', :action => 'new'
-  map.reader_logout '/logout', :controller => 'reader_sessions', :action => 'destroy'
-  map.reader_dashboard '/dashboard', :controller => 'accounts', :action => 'dashboard'
-  map.reader_account '/account', :controller => 'accounts', :action => 'edit'
-  map.reader_profile '/profile', :controller => 'accounts', :action => 'show'
-  map.reader_edit_profile '/edit_profile', :controller => 'accounts', :action => 'edit_profile'
-  map.reader_permission_denied '/permission_denied', :controller => 'accounts', :action => 'permission_denied'
+  map.reader_index readers_prefix, :controller => 'accounts', :action => 'index'
+  map.reader_dashboard accounts_prefix, :controller => 'accounts', :action => 'dashboard'
+
 end

data/db/migrate/001_create_readers.rb

@@ -20,7 +20,6 @@ class CreateReaders < ActiveRecord::Migration
       t.column :activation_code, :string
       t.column :provisional_password, :string
       t.column :activated_at, :datetime
-      # t.column :lock_version, :integer, :default => 0
     end
     add_index :readers, ["session_token"], :name => "session_token"
   end

data/db/migrate/20090921125653_reader_messages.rb

@@ -9,7 +9,6 @@ class ReaderMessages < ActiveRecord::Migration
       t.column :updated_at, :datetime
       t.column :created_by_id, :integer
       t.column :updated_by_id, :integer
-      t.column :lock_version, :integer
     end
 
     create_table :message_readers do |t|

data/db/migrate/20090921125654_group_messages.rb

@@ -9,7 +9,6 @@ class GroupMessages < ActiveRecord::Migration
     t.column :updated_by_id, :integer
     t.column :homepage_id, :integer
     t.column :site_id, :integer
-    t.column :lock_version, :integer
   end
 
   create_table :memberships do |t|

data/db/migrate/20110812111934_groups_nested_set.rb

@@ -0,0 +1,19 @@
+class GroupsNestedSet < ActiveRecord::Migration
+  def self.up
+    add_column :groups, :parent_id, :integer
+    add_column :groups, :root_group_id, :integer
+    add_column :groups, :lft, :integer
+    add_column :groups, :rgt, :integer
+    
+    Group.reset_column_information
+    Group.rebuild!
+    Group.all.each {|g| g.save }
+  end
+
+  def self.down
+    remove_column :groups, :parent_id
+    remove_column :groups, :root_group_id
+    remove_column :groups, :lft
+    remove_column :groups, :rgt
+  end
+end

data/db/migrate/20110814070858_message_has_many_groups.rb

@@ -0,0 +1,14 @@
+class MessageHasManyGroups < ActiveRecord::Migration
+  def self.up
+    Message.all.each do |m|
+      if g = Group.find_by_id(m.group_id)
+        m.permit(g)
+      end
+    end
+    remove_column :messages, :group_id 
+  end
+
+  def self.down
+    add_column :messages, :group_id , :integer
+  end
+end

data/db/migrate/20110905194602_group_ancestry.rb

@@ -0,0 +1,23 @@
+class GroupAncestry < ActiveRecord::Migration
+  def self.up
+    remove_column :groups, :root_group_id
+    remove_column :groups, :lft
+    remove_column :groups, :rgt
+    add_column :groups, :ancestry, :string
+    add_index :groups, :ancestry
+    
+    Group.reset_column_information
+    Group.build_ancestry_from_parent_ids!
+    
+    remove_column :groups, :parent_id
+  end
+
+  def self.down
+    remove_column :groups, :ancestry
+    remove_index :groups, :ancestry
+    add_column :groups, :parent_id
+    add_column :groups, :root_group_id, :integer
+    add_column :groups, :lft, :integer
+    add_column :groups, :rgt, :integer
+  end
+end

data/lib/controller_extensions.rb

@@ -3,6 +3,10 @@ module ControllerExtensions    # for inclusion into ApplicationController
   def self.included(base)
     
     base.class_eval do
+      rescue_from ReaderError::AccessDenied, :with => :access_denied
+      rescue_from ReaderError::LoginRequired, :with => :login_required
+      rescue_from ReaderError::ActivationRequired, :with => :activation_required
+
       before_filter :set_reader_for_user
       before_filter :set_reader
       helper_method :current_reader_session, :current_reader, :current_reader=
@@ -69,6 +73,51 @@ module ControllerExtensions    # for inclusion into ApplicationController
       redirect_to address + ".#{format}"    # nasty! but necessary for inline login.
     end
 
+    # reader-permission exception handling
+
+    def login_required(e)
+      @message = e.message
+      respond_to do |format|
+        format.html {
+          flash[:explanation] = t('reader_extension.reader_required')
+          flash[:notice] = e.message
+          redirect_to reader_login_url 
+        }
+        format.js { 
+          @inline = true
+          render :partial => 'reader_sessions/login_form'
+        }
+      end
+    end
+
+    def activation_required(e)
+      @message = e.message
+      respond_to do |format|
+        format.html { 
+          flash[:explanation] = t('reader_extension.activation_required')
+          redirect_to reader_activation_url 
+        }
+        format.js { 
+          @inline = true
+          render :partial => 'reader_activations/activation_required' 
+        }
+      end
+    end
+
+    def access_denied(e)
+      @message = e.message
+      respond_to do |format|
+        format.html { 
+          flash[:explanation] = t('reader_extension.access_denied')
+          flash[:notice] = e.message
+          render :template => 'shared/not_allowed' 
+        }
+        format.js { 
+          render :text => @message, :status => 403
+        }
+      end
+    end
+
   end
 end
 

data/lib/grouped_model.rb

@@ -1,14 +1,36 @@
 module GroupedModel
+  
+  # Grouped Models are those that can be assigned to one or more groups, and so made invisible to any reader 
+  # who is not a member of one of those groups. As standard this is applied to pages and messages.
+  # To group-limit another class:
+  #
+  # class Widget < ActiveRecord::Base
+  #   has_groups
+  #   ...
+  #
+  # This will define several class and instance methods and some scopes, most usefully:
+  #
+  # Widget#groups               -> groups association can << and +/- in the usual ways
+  # Group#widgets               -> a scope, not an association
+  # Widget#visible_to?(reader)  -> boolean
+  # Widget.visible_to(reader)   -> list of visible widgets (as scope)
+  # Widget.belonging_to(group)  -> list of widgets
+  #
+  # The situation is more complex than it seems because of polymorphy and group-inheritance but that should all be taken care of for you.
+  #
   def self.included(base)
     base.extend ClassMethods
   end
 
   module ClassMethods
+    # Returns true if group relations have been established in this model.
     def has_groups?
       false
     end
     alias :has_group? :has_groups?
     
+    # Sets up group relations and scopes in this model. No extra columns are required in the model table.
+    #
     def has_groups(options={})
       return if has_groups?
       
@@ -25,13 +47,14 @@ module GroupedModel
       }
       
       has_many :permissions, :as => :permitted
+      accepts_nested_attributes_for :permissions
       has_many :groups, :through => :permissions
       Group.define_retrieval_methods(self.to_s)
 
       named_scope :visible_to, lambda { |reader| 
         conditions = "pp.group_id IS NULL"
-        if reader && reader.groups.any?
-          ids = reader.group_ids
+        if reader && reader.is_grouped?
+          ids = reader.all_group_ids
           conditions = ["#{conditions} OR pp.group_id IS NULL OR pp.group_id IN(#{ids.map{"?"}.join(',')})", *ids]
         end
         {
@@ -70,14 +93,20 @@ module GroupedModel
         end
       end
       
-      named_scope :belonging_to, lambda { |group| 
+      named_scope :belonging_to, lambda { |group|
+        group_ids = group.subtree_ids
         {
           :joins => "INNER JOIN permissions as pp on pp.permitted_id = #{self.table_name}.id AND pp.permitted_type = '#{self.to_s}'", 
           :group => column_names.map { |n| self.table_name + '.' + n }.join(','),
-          :conditions => ["pp.group_id = ?", group.id],
+          :conditions => ["pp.group_id IN (#{group_ids.map{"?"}.join(',')})", *group_ids],
           :readonly => false
         }
       }
+      
+      named_scope :find_these, lambda { |ids|
+        ids = ['NULL'] unless ids && ids.any?
+        { :conditions => ["#{self.table_name}.id IN (#{ids.map{"?"}.join(',')})", *ids] }
+      }
             
     end
     alias :has_group :has_groups
@@ -85,13 +114,25 @@ module GroupedModel
 
   module GroupedInstanceMethods
 
-    # in GroupedPage this is chained to include inherited groups
+    # The list of groups that is allowed to see this object. This will include the groups directly
+    # associated and their descendant subgroups.
+    #
     def permitted_groups
-      groups
+      if permitted_group_ids.any?
+        Group.find(permitted_group_ids)
+      else
+        []
+      end
+    end
+
+    def permitted_group_ids
+      # in GroupedPage this is chained to include groups inherited from ancestor pages
+      # while here the subtrees provide inheritance from ancestor groups.
+      #
+      groups.map(&:subtree_ids).flatten.uniq
     end
 
     def visible_to?(reader)
-      Rails.logger.warn "grouped_model#visible_to?"
       return true if self.permitted_groups.empty?
       return false if reader.nil?
       return true if reader.is_admin?
@@ -111,7 +152,7 @@ module GroupedModel
     end
 
     def permitted_readers
-      permitted_groups.any? ? Reader.in_groups(permitted_groups) : Reader.all
+      permitted_groups.any? ? Reader.in_groups(permitted_groups) : Reader.scoped({})
     end
     
     def has_group?(group)

data/lib/grouped_page.rb

@@ -5,7 +5,7 @@ module GroupedPage
       has_groups
       has_one :homegroup, :foreign_key => 'homepage_id', :class_name => 'Group'
       include InstanceMethods
-      alias_method_chain :permitted_groups, :inheritance
+      alias_method_chain :permitted_group_ids, :inheritance
     }
   end
   
@@ -15,14 +15,26 @@ module GroupedPage
     def inherited_groups
       @inherited_groups ||= self.parent ? Group.attached_to(self.ancestors) : []
     end
+    
+    # If a grandparent page is associated with a supergroup page
+    # then all of the descendant pages are bound to all of the descendant groups.
+    def inherited_group_ids
+      self.ancestors.map(&:group_ids).flatten.uniq
+    end
 
-    def permitted_groups_with_inheritance
-      permitted_groups_without_inheritance + inherited_groups
+    def permitted_group_ids_with_inheritance
+      (permitted_group_ids_without_inheritance + inherited_group_ids).flatten.uniq
     end
 
-    # this is regrettably expensive
+    def restricted?
+      self.permitted_groups.any?
+    end
+    
+    # this is regrettably expensive and I plan to replace it with a 
+    # private? method that would be cascaded on page update
+    #
     def cache?
-      self.permitted_groups.empty?
+      !restricted?
     end        
 
     def has_inherited_group?(group)

data/lib/message_tags.rb

@@ -77,10 +77,28 @@ module MessageTags
 
   desc %{
     Only for use in email messages. Displays the preferences url of the reader currently being emailed.
-    <pre><code><r:recipient:url /></code></pre>
+    <pre><code><r:recipient:edit_preferences_url /></code></pre>
+  }
+  tag "recipient:edit_preferences_url" do |tag|
+    
+    Rails.logger.warn "and the :host argument will be #{@mailer_vars[:@host]}"
+    Rails.logger.warn "giving us #{reader_account_url(:host => @mailer_vars[:@host])}"
+    
+    reader_account_url(:host => @mailer_vars[:@host])
+  end
+
+  desc %{
+    Please replace your old r:recipient:edit_url tags with either `r:recipient:edit_profile_url` or `r:recipient:edit_preferences_url`.
+    <pre><code><r:recipient:edit_url /></code></pre>
+  }
+  deprecated_tag "recipient:edit_url", :substitute => 'recipient:edit_preferences_url'
+
+  desc %{
+    Only for use in email messages. Displays the edit-my-profile url of the reader currently being emailed.
+    <pre><code><r:recipient:edit_profile_url /></code></pre>
   }
-  tag "recipient:edit_url" do |tag|
-    edit_reader_url(tag.locals.recipient, :host => @mailer_vars[:@host])
+  tag "recipient:edit_profile_url" do |tag|
+    reader_edit_profile_url(:host => @mailer_vars[:@host])
   end
 
   desc %{

data/lib/radiant-reader-extension.rb

@@ -1,5 +1,5 @@
 module RadiantReaderExtension
-  VERSION = '3.0.0.rc4'
+  VERSION = '3.0.0'
   SUMMARY = %q{Reader/viewer/visitor registration, login and access-control for Radiant CMS}
   DESCRIPTION = %q{Provides reader/member/user registration and management functions including password-reminder, group-based page access control and administrative email.}
   URL = "http://radiant.spanner.org/reader"

data/lib/reader_admin_ui.rb

@@ -64,8 +64,8 @@ module ReaderAdminUI
             edit.form_bottom.concat %w{edit_timestamp edit_buttons}
           end
           message.index = Radiant::AdminUI::RegionSet.new do |index|
-            index.thead.concat %w{subject_header sent_header modify_header}
-            index.tbody.concat %w{subject_cell sent_cell modify_cell}
+            index.thead.concat %w{subject_header function_header groups_header sent_header modify_header}
+            index.tbody.concat %w{subject_cell function_cell groups_cell sent_cell modify_cell}
             index.bottom.concat %w{buttons}
           end
           message.show = Radiant::AdminUI::RegionSet.new do |show|
@@ -107,12 +107,11 @@ module ReaderAdminUI
           dashboard.sidebar.concat %w{dashboard/profile dashboard/messages dashboard/directory}
         end
         account.index = Radiant::AdminUI::RegionSet.new do |index|
-          index.main.concat %w{list}
-          index.sidebar.concat %w{groups/all}
+          index.main.concat %w{readers/groups readers/people}
         end
         account.show = Radiant::AdminUI::RegionSet.new do |show|
-          show.main.concat %w{groups description}
-          show.sidebar.concat %w{profile}
+          show.main.concat %w{readers/memberships readers/description}
+          show.sidebar.concat %w{readers/profile}
         end
         account.edit = Radiant::AdminUI::RegionSet.new do |edit|
           edit.main.concat %w{preamble form gravatar}
@@ -120,8 +119,8 @@ module ReaderAdminUI
           edit.form_bottom.concat %w{edit_buttons}
         end
         account.edit_profile = Radiant::AdminUI::RegionSet.new do |edit_profile|
-          edit_profile.main.concat %w{edit_header edit_form}
-          edit_profile.form.concat %w{edit_honorific edit_name edit_email edit_phone edit_mobile edit_address edit_shareability}
+          edit_profile.main.concat %w{preamble profile_form gravatar}
+          edit_profile.profile_form.concat %w{edit_honorific edit_name edit_email edit_phone edit_mobile edit_address edit_shareability}
           edit_profile.form_bottom.concat %w{edit_buttons}
         end
         account.new = account.edit

data/lib/reader_tags.rb

@@ -26,7 +26,7 @@ module ReaderTags
     
     Please note that if you use this tag on a normal radiant page, all registered readers
     will be displayed, regardless of group-based or other access limitations. You really
-    want to keep this tag for ReaderPages and GroupPages.
+    want to keep this tag for ReaderPages and (soon) GroupPages.
     
     *Usage:* 
     <pre><code><r:readers:each [limit=0] [offset=0] [order="asc|desc"] [by="position|title|..."] [extensions="png|pdf|doc"]>...</r:readers:each></code></pre>