radiant-forum-extension 0.6.1 → 1.1.0

data/app/views/topics/new.html.haml

@@ -1,40 +1,45 @@
-= render :partial => 'readers/flasher'
+- content_for :signals do
+  = render :partial => 'readers/flasher'
 
-#forum
-  #new_topic
-    - form_for :topic, :url  => @forum ? forum_topics_path(@forum) : topics_path, :html => {:class => 'friendly', :multipart => true} do |f|
-      = render :partial => "form", :object => f
-      %p.buttons
-        = submit_tag 'Start Discussion' 
-        or 
-        - if @forum
-          = link_to('cancel', forum_path(@forum))
-        - else
-          = link_to('cancel', :back)
-
-- content_for :pagetitle do
-  Start a new discussion
+- content_for :form do
+  - form_for :topic, :url  => @forum ? forum_topics_path(@forum) : topics_path, :html => {:class => 'friendly', :multipart => true} do |f|
+    = render :partial => "form", :object => f
+    %p.buttons
+      = submit_tag t('new_topic_button')
+      or 
+      - if @forum
+        = link_to t('cancel'), forum_path(@forum)
+      - else
+        = link_to t('cancel'), :back
+
+- content_for :title do
+  = t('new_topic_heading')
 
 - content_for :breadhead do
+  = link_to t('forum'), forum_home_url
+  = t('separator')
   - if @forum
-    = link_to @forum.name, forum_url(@forum), :class => 'breadhead'
-  - else
-    = link_to "Forum", topics_url, :class => 'breadhead'
+    = link_to @forum.name, forum_url(@forum)
   
 - content_for :controls do
   = render :partial => 'readers/controls'
 
 - content_for :credits do
-  %p.context
-    You are logged in as 
-    = link_to "#{current_reader.name}.", reader_url(current_reader)
-    If that's not you, please 
-    = link_to "log out.", reader_logout_url
+  %p
+    = t('logged_in_as', :name => current_reader.name)
+    = t('if_not_you')
+    = link_to t('log_out'), reader_logout_url
 
 - content_for :breadcrumbs do
-  = link_to 'Forum', topics_url
-  \>
+  = link_to t('forum'), topics_url
+  = t('separator')
   - if @forum
     = link_to @forum.name, forum_url(@forum)
-    \>
-  New Discussion
+    = t('separator')
+  = t('new_topic')
+
+
+#forum
+  = yield :credits
+  = yield :form
+

data/app/views/topics/show.html.haml

@@ -1,20 +1,24 @@
-= render :partial => 'readers/flasher'
+- content_for :signals do
+  = render :partial => 'readers/flasher'
 
-#forum
-  - if @posts.previous_page
-    = paginate_and_summarise @posts, 'comments'
+- content_for :messages do
+  = render :partial => 'posts/post', :collection => @posts, :locals => { :with_context => false }
 
-  = render :partial => 'posts/post', :collection => @posts, :locals => { :with_context => false, :first_post => @topic.posts.first }
+- content_for :new_topic do
+  .newmessage
+    = link_to t('new_topic_here'), new_forum_topic_url(@forum)
 
-  - if @posts.next_page
-    = paginate_and_summarise @posts, 'comments'
-  - else
+- content_for :reply_form do
+  - unless @posts.next_page
     - if @topic.page
       = link_to "Post a reply", new_topic_post_url(@topic), :class => 'inviting remote_content'
     - else
       = render :partial => 'posts/reply'
 
-- content_for :pagetitle do
+- content_for :pagination do
+  = pagination_and_summary_for(@posts, t('post'))
+
+- content_for :title do
   = @topic.name
 
 - content_for :credits do
@@ -35,7 +39,9 @@
   = render :partial => 'readers/controls'
 
 - content_for :breadhead do
-  = link_to @forum.name, forum_url(@forum), :class => 'breadhead'
+  = link_to t('forum'), forum_home_url
+  = t('separator')
+  = link_to @forum.name, forum_url(@forum)
 
 - content_for :breadcrumbs do
   = link_to 'Forum', topics_url
@@ -43,3 +49,12 @@
   = link_to @forum.name, forum_url(@forum) 
   \>
   = @topic.name
+
+#forum
+  = yield :pagination if @posts.previous_page
+  = yield :messages
+  = yield :pagination if @posts.next_page
+  = yield :reply_form
+
+
+

data/config/locales/en.yml

@@ -0,0 +1,58 @@
+en:
+  all: "all"
+  by: "by"
+  config:
+    forum:
+      allow_page_comments?: "Page comments allowed"
+      comments_have_attachments?: "Attachments allowed"
+      editable_period: "Editable period"
+      layout: "Forum layout"
+      public?: "Forum public?"
+  date_this_year: "on %B %e at %l:%M%p"
+  edit_your_post: "edit your post"
+  forum: "Forum"
+  forums: "Discussion categories"
+  forums_introduction: "These are the broad filing areas we use to organise the forum. You can also see a list of "
+  if_not_you: "If that's not you, please"
+  latest_discussion: "Latest topics"
+  latest_posts: "Latest comments"
+  latest_topics: "all the latest topics"
+  logged_in_as: "You are logged in as %{name}."
+  new_topic: "new topic"
+  new_topic_button: "Submit topic"
+  new_topic_heading: "Start a new topic"
+  new_topic_here: "start a new<br />topic here"
+  no_forums: "No discussion categories defined here yet."
+  no_posts: "The forum is empty."
+  no_topics: "No talk here yet."
+  of: "of"
+  on: "on"
+  post: "comment"
+  post_count_from: 
+    zero: ""
+    one: "One comment, from"
+    other: "%{count} comments, most recently from"
+  post_removed: "Post removed"
+  posted_and_updated_on: "posted %{posted} and updated %{updated}"
+  posted_by: "Posted by"
+  posted_on: "posted %{date}"
+  posts_introduction: "This is a list of all forum posts by date."
+  really_remove_post: "Are you sure you want to delete this comment?"
+  remove_post: "delete comment"
+  replied_on: "replied on %{date}"
+  rss_feed: "RSS feed"
+  separator: '&raquo;'
+  showing: "showing"
+  standard_date: "on %B %e, %Y"
+  started_topic_in: "started a new topic under"
+  started_topic_on: "started a new topic on %{date}"
+  time_recently: "on %A at %l:%M%p"
+  time_remaining_to_edit: "You have %{time} left to "
+  time_today: "today at %l:%M%p"
+  time_yesterday: "yesterday at %l:%M%p"
+  to: "to"
+  topic: "topic"
+  topic_empty: "Topic empty!"
+  topics: "topics"
+  topics_introduction: "This is a list of all the discussions going on here, with the most recently updated first. You can also see a more organised list of"
+  unknown_date: "unknown date"

data/config/routes.rb

@@ -6,11 +6,11 @@ ActionController::Routing::Routes.draw do |map|
     forum.resources :pages, :has_many => [:posts], :has_one => [:topic]
   end
   
-  # forum admin is nested under readers to save interface clutter
-  # some time soon I'll add proper moderation of topics and posts
-  map.namespace :admin, :member => { :remove => :get }, :path_prefix => 'admin/readers' do |admin|
+  map.namespace :admin, :member => { :remove => :get }, :path_prefix => 'admin/forum' do |admin|
     admin.resources :forums
-    # admin.resources :topics
-    # admin.resources :posts
+    admin.resources :topics
+    admin.resources :posts
   end
+  
+  map.forum_home "/forum.:format", :controller => 'topics', :action => 'index'
 end

data/forum_extension.rb

@@ -1,10 +1,14 @@
 require_dependency 'application_controller'
 
 class ForumExtension < Radiant::Extension
-  version "0.6.1"
+  version "1.1.0"
   description "Nice clean forums and page comments for inclusion in your radiant site. Derived long ago from beast. Requires the reader extension and share_layouts."
   url "http://spanner.org/radiant/forum"
 
+  extension_config do |config|
+    config.gem "paperclip"
+  end
+
   def activate
     Reader.send :include, ForumReader
     ReaderNotifier.send :include, ForumReaderNotifier
@@ -18,12 +22,14 @@ class ForumExtension < Radiant::Extension
     unless defined? admin.forum # UI is a singleton
       Radiant::AdminUI.send :include, ForumAdminUI
       admin.forum = Radiant::AdminUI.load_default_forum_regions
-      # admin.pages.edit.add :parts_bottom, "edit_commentability", :after => "edit_layout_and_type"
-      admin.reader_configuration.show.add :settings, "forum", :after => "sender"
-      admin.reader_configuration.edit.add :form, "edit_forum", :after => "edit_sender"
-      if defined? Site && admin.sites
-        Site.send :include, ForumSite
-      end
+    end
+    
+    # admin.pages.edit.add :parts_bottom, "edit_commentability", :after => "edit_layout_and_type"
+    admin.reader_configuration.show.add :settings, "forum", :after => "sender"
+    admin.reader_configuration.edit.add :form, "edit_forum", :after => "edit_sender"
+    
+    if defined? Site && admin.sites
+      Site.send :include, ForumSite
     end
     
     if defined? RedCloth::DEFAULT_RULES     # identifies redcloth 3
@@ -32,11 +38,12 @@ class ForumExtension < Radiant::Extension
     else
       RedCloth::TextileDoc.send :include, ForumRedCloth4
     end
-    
-    ApplicationHelper.send :include, ForumHelper
 
-    tab("Readers") do
-      add_item 'Forum', '/admin/readers/forums', :before => 'Settings'
+    tab("Forum") do
+      add_item 'Categories', '/admin/forum/forums'
+      add_item 'Topics', '/admin/forum/topics'
+      add_item 'Posts', '/admin/forum/posts'
+      add_item 'Settings', '/admin/forum/settings'
     end
   end
   

data/lib/forum_readers_controller.rb

@@ -2,6 +2,7 @@ module ForumReadersController
 
   def self.included(base)
     base.class_eval do
+      helper :forum
       alias_method_chain :show, :forum 
     end
   end

data/lib/tasks/radiant_forum_extension_tasks.rake

@@ -28,15 +28,25 @@ namespace :radiant do
         desc "Quick and dirty import from Vanilla."
         task :vanilla => :environment do
           require 'dbi'
-        
+
+          clear = ENV['clear'] || false
+          if clear == 'true'
+            p "*** deleting all forum data"
+            Forum.delete_all
+            Topic.delete_all
+            Post.delete_all
+          end
+          
           database = ENV['database'] || 'vanilla'
           user = ENV['user'] || 'forum'
           password = ENV['password'] || ''
+          host = ENV['host'] || '127.0.0.1'
           Page.current_site = Site.find_by_id(ENV['site']) if ENV['site'] && defined? Site
         
-          dbh = DBI.connect("DBI:Mysql:#{database}", user, password)
+          p "*** connecting to #{database} database at #{host}"
+          dbh = DBI.connect("DBI:Mysql:#{database}:#{host}", user, password)
         
-          dbh.select_all('select * from LUM_User') do | row |
+          dbh.select_all('select * from LUM_User') do |row|
             begin
               reader = Reader.find_or_create_by_email(row['Email'])
               if reader.new_record?
@@ -72,62 +82,75 @@ namespace :radiant do
                 :description => row['Description'],
                 :position => row['Priority']
               )
-              p "Imported forum #{forum.name}"
+              p "Imported category #{forum.name}"
             end
           end
         
           posts = {}
           topic_posts = {}
-          dbh.select_all('select * from LUM_Comment ORDER BY DateCreated ASC') do | row |
-            posts[row['CommentID']] = row
-            topic_posts[row['DiscussionID']] ||= []
-            topic_posts[row['DiscussionID']].push(row)
+          
+          dbh.select_all('select * from LUM_Comment ORDER BY DateCreated ASC') do |row|
+            hash = row.to_h
+            posts[row['CommentID'].to_i] = hash
+            topic_posts[row['DiscussionID'].to_i] ||= []
+            topic_posts[row['DiscussionID'].to_i].push(hash)
           end
           
           p "*** importing topics"
-          
-          dbh.select_all('select * from LUM_Discussion') do | row |
-            first_post = posts[row['FirstCommentID']] || topic_posts[row['DiscussionID']].shift
-            forum = Forum.find_by_old_id(row['CategoryID'])
-            raise "no forum for old id #{row['CategoryID']}. Go fix." unless forum
+          dbh.select_all('select * from LUM_Discussion ORDER BY DiscussionID ASC') do |row|
+            old_id = row['DiscussionID'].to_i
+            cat_id = row['CategoryID'].to_i
+            fp_id = row['FirstCommentID'].to_i
+            
+            unless first_post = posts[fp_id]
+              if topic_posts[old_id]
+                first_post = topic_posts[old_id].shift
+                p "! first post missing: shifted #{first_post['CommentID']} from stack."
+              end
+            end
+            forum = Forum.find_by_old_id(cat_id)
+            raise RuntimeError, "no forum for category id #{cat_id}. Go fix." unless forum
+                        
             if forum && first_post
               topic = forum.topics.build(
-                :reader => Reader.find_by_old_id(row['AuthUserID']),
+                :reader => Reader.find_by_old_id(row['AuthUserID'].to_i),
                 :name => row['Name'],
                 :body => first_post['Body'],
                 :created_at => row['DateCreated'],
-                :replied_at => topic_posts[row['DiscussionID']].last['DateCreated'],
                 :sticky => row['Sticky'],
                 :locked => row['Closed'],
-                :replied_by => Reader.find_by_old_id(row['LastUserID']),
                 :old_id => row['DiscussionID']
               )
                           
               begin
                 if topic.save!
-                  p "Imported topic #{topic.name}"
-          
-                  topic_posts[row['DiscussionID']].each do |post|
-                    unless post['CommentID'] == row['FirstCommentID']          # first post is created in a pre-validation filter, so we can't check for its old_id
-                      post = topic.posts.build(
-                        :forum => forum,
-                        :reader => Reader.find_by_old_id(post['AuthUserID']),
-                        :created_at => post['DateCreated'],
-                        :updated_at => post['DateEdited'],
-                        :body => post['Body'],
-                        :old_id => post['CommentID']
-                      )
-                      post.save
+                  p "Imported topic #{old_id}: #{topic.name}. posts to import: #{topic_posts[old_id].length}"
+                  topic_posts[old_id].each do |post|
+                    begin
+                      unless post['CommentID'] == row['FirstCommentID']          # first_post is created in a pre-validation filter, so we can't check for its old_id
+                        topic.posts.build(
+                          :forum => forum,
+                          :reader => Reader.find_by_old_id(post['AuthUserID'].to_i),
+                          :created_at => post['DateCreated'],
+                          :updated_at => post['DateEdited'],
+                          :body => post['Body'],
+                          :old_id => post['CommentID']
+                        ).save!
+                      end
+                    rescue ActiveRecord::RecordInvalid => e
+                      p "!!! failed to import post #{post['CommentID']}: #{e.inspect}"
                     end
                   end
                   p "... with #{topic.posts.count} post" + (topic.posts.count == 1 ? '' : 's')
                 end
               rescue ActiveRecord::RecordInvalid => e
-                p "!!! failed to import topic #{row['DiscussionID']}: #{e.inspect}"
+                p "!!! failed to import topic #{old_id}: #{e.inspect}"
+                p "    (reader is #{topic.reader.inspect})"
+                p "    (body is #{topic.body.inspect})"
               end
               
             else
-              p "skipping topic #{row['Name']}: no post"
+              p "skipping topic #{row['Name']} (#{old_id}): no post"
             end
           end
         end

data/public/javascripts/forum.js

@@ -0,0 +1,198 @@
+/*
+  Sample jquery-based forum scripts.
+  
+  Two functions are handled here: 
+  * inline editing of posts by authors and administrators.
+  * attachment and upload of files.
+*/
+
+(function($) { 
+
+  $.ajaxSetup({
+    'beforeSend': function(xhr) {
+      xhr.setRequestHeader("Accept", "text/javascript");
+    }
+  });
+  
+	function EditablePost(container, conf) {   
+    var self = this;
+		$.extend(self, {
+		  container: container,
+      edit_links: $(container.find('a.edit_post')),
+      edit_url: null,
+      form: null,
+			stumbit: null,
+			textarea: null,
+      showing: false,
+			header: null,
+      wrapper: null,
+      body_holder: null,
+      form_holder: null,
+      form_waiter: null,
+      uploader: null,
+      
+			initEdit: function(event) {
+			  squash(event);
+        self.edit_links.addClass('waiting');
+        if (self.showing) self.cancelEdit();            // toggle form off again
+        else if (self.form_holder) self.showForm();     // show previously-loaded form
+        else {                                          // load form
+          self.header = $(container.find('.post_header'));
+          self.wrapper = $(container.find('.post_wrapper'));
+          self.body_holder = $(container.find('.post_body'));
+          self.edit_links = $(container.find('a.edit_post'));
+          self.getForm();
+        } 
+			},
+			
+			getForm: function () {
+        if (self.edit_url) self.reusableFormHolder().load(self.edit_url, self.captureForm);
+      },
+      
+      // lazy-load a container div that is then held in memory instead of 
+      // going back to the server for another edit form
+      reusableFormHolder: function () {
+        if (self.form_holder) return self.form_holder;
+        self.form_holder = $('<div class="post_form" />');
+        self.wrapper.prepend(self.form_holder);
+        return self.form_holder;
+      },
+
+			captureForm: function () {
+        self.form = self.form_holder.find('form');
+        self.textarea = self.form.find('textarea');
+        self.form_holder.find('a.cancel').click(self.cancelEdit);
+        self.uploader = new UploadStack(self.form_holder.find('div.upload_stack'));
+        self.stumbit = self.form_holder.find('div.buttons');
+        self.form.submit(self.sendForm);
+        self.showForm();
+      },
+            
+      showForm: function () {
+        self.edit_links.removeClass('waiting');
+        self.body_holder.hide();
+        self.reusableFormHolder().show();
+        self.showing = true;
+      },
+      
+      hideForm: function () {
+        self.reusableFormHolder().hide();
+        self.body_holder.show();
+        self.showing = false;
+      },
+
+      sendForm: function (event) {
+        self.form_waiter = $('<p class="waiting">Please wait</p>');
+        self.stumbit.hide();
+        self.form_waiter.after(self.stumbit);
+        
+        console.log("uploader:", self.uploader, self.uploader.hasUploads());
+        
+        if (self.uploader && self.uploader.hasUploads()) {
+          console.log("yes uploads");
+          return true;  // can't send uploads over xmlhttp so we allow the event to pass through
+        } else {
+          console.log("no uploads");
+          squash(event);
+          $.post(self.form.attr('action'), self.form.serialize(), self.finishEdit);
+        }
+      },
+
+      cancelEdit: function (event) {
+        squash(event);
+        self.edit_links.removeClass('waiting');
+        self.hideForm();
+      },
+      
+      finishEdit: function (results) {
+        self.form_holder.remove();
+        self.form_holder = null;
+        self.container.html(results);
+        self.body_holder.animate( { backgroundColor: 'pink' }, 200).animate( { backgroundColor: 'white' }, 1000);
+        self.container.editable_post();
+      }
+		});
+
+    self.edit_url = self.edit_links.attr('href');
+    self.edit_links.click(self.initEdit);
+	}
+	
+	$.tools.post = {
+		conf: {	
+
+		}
+	};
+	
+	$.fn.editable_post = function(conf) { 
+		conf = $.extend({}, $.tools.post.conf, conf); 
+		this.each(function() {			
+			el = new EditablePost($(this), conf);
+		});
+		return this;
+	};
+	
+	function UploadStack(container) {   
+    var self = this;
+		$.extend(self, {
+		  container: container,
+      attachments_list: container.find('ul.attachments'),
+      uploads_list: container.find('ul.uploads'),
+      selector: container.find('div.selector'),
+      file_field: container.find('div.selector').find('input'),
+      
+			addUpload: function(event) {
+        squash(event);
+        var upload_field = self.file_field.clone();
+        var container = $('<li class="attachment">' + upload_field.val() + '</li>');
+        container.append(upload_field);
+        container.add_remover();
+        container.appendTo(self.uploads_list).slideDown('slow');
+        self.file_field.val(null);
+        self.selector.find('a').text = 'attach another file';
+      },
+      
+      hasAttachments: function () {
+        return self.attachments_list.find('li').length > 0;
+      },
+      
+      hasUploads: function () {
+        return self.uploads_list.find('li').length > 0;
+      }
+    });
+    self.attachments_list.find('li').add_remover();
+    self.file_field.change(self.addUpload);
+	}
+
+	$.tools.stack = {
+		conf: {	
+
+		}
+	};
+	
+	$.fn.upload_stack = function(conf) { 
+		conf = $.extend({}, $.tools.stack.conf, conf); 
+		this.each(function() {			
+			el = new UploadStack($(this), conf);
+		});
+		return this;
+	};
+
+	$.fn.add_remover = function() { 
+	  this.each(function() {
+  	  var self = $(this);
+      var remover = $('<a href="#" class="remove">remove</a>');
+      remover.click(function (event) { 
+        squash(event);
+        self.slideUp('500', function() { self.remove(); }); 
+      });
+      self.append(remover);
+	  });
+		return self;
+	};
+
+})(jQuery);
+
+$(function() {
+  $(".post").editable_post({});
+  $(".upload_stack").upload_stack({});
+});