dm_forum 4.2.1.5

data/app/datatables/forum_user_datatable.rb

@@ -0,0 +1,79 @@
+class ForumUserDatatable
+  include ActionView::Helpers::TagHelper
+  
+  delegate :params, :link_to, :image_tag, :number_to_currency, :time_ago_in_words, to: :@view
+  delegate :url_helpers, to: 'DmForum::Engine.routes'
+  
+  #------------------------------------------------------------------------------
+  def initialize(view, forum)
+    @view   = view
+    @forum  = forum
+  end
+
+  #------------------------------------------------------------------------------
+  def as_json(options = {})
+    {
+      sEcho: params[:sEcho].to_i,
+      iTotalRecords: User.count,
+      iTotalDisplayRecords: users.total_entries,
+      aaData: data
+    }
+  end
+
+private
+
+  #------------------------------------------------------------------------------
+  def data
+    users.map do |user|
+      [
+        action(user),
+        user.country.nil? ? 'n/a' : user.country.english_name,
+      ]
+    end
+  end
+
+  #------------------------------------------------------------------------------
+  def users
+    @users ||= fetch_users
+  end
+
+  #------------------------------------------------------------------------------
+  def fetch_users
+    users = User.includes(:user_profile => [ :country ] ).references(:user_profile).order("#{sort_column} #{sort_direction}")
+    users = users.page(page).per_page(per_page)
+    if params[:sSearch].present?
+      users = users.where("LOWER(user_profiles.first_name) like :search OR LOWER(user_profiles.last_name) like :search OR LOWER(users.email) like :search", search: "%#{params[:sSearch]}%".downcase)
+    end
+    users
+  end
+
+  #------------------------------------------------------------------------------
+  def page
+    params[:iDisplayStart].to_i/per_page + 1
+  end
+
+  #------------------------------------------------------------------------------
+  def per_page
+    params[:iDisplayLength].to_i > 0 ? params[:iDisplayLength].to_i : 50
+  end
+
+  #------------------------------------------------------------------------------
+  def sort_column
+    columns = ["LOWER(user_profiles.first_name) #{sort_direction}, LOWER(user_profiles.last_name)", 'globalize_countries.english_name']
+    columns[params[:iSortCol_0].to_i]
+  end
+
+  #------------------------------------------------------------------------------
+  def sort_direction
+    params[:sSortDir_0] == "desc" ? "desc" : "asc"
+  end
+
+  #------------------------------------------------------------------------------
+  def action(user)
+    if @forum.member? user
+      icons(:checkmark) + "  ".html_safe + user.full_name
+    else
+      link_to(icons(:add), url_helpers.forum_add_member_admin_forum_path(@forum, :locale => DmCore::Language.locale, :user_id => user.id), :title => 'Add Access') + "  ".html_safe + user.full_name
+    end
+  end
+end

data/app/helpers/dm_forum/application_helper.rb

@@ -0,0 +1,5 @@
+module DmForum
+  module ApplicationHelper
+    include ForumHelper
+  end
+end

data/app/helpers/dm_forum/forum_helper.rb

@@ -0,0 +1,109 @@
+module DmForum
+  module ForumHelper
+
+    #------------------------------------------------------------------------------
+    def topic_title_link(topic, options)
+      if topic.title =~ /^\[([^\]]{1,15})\]((\s+)\w+.*)/
+        "<span class='flag'>#{$1}</span>" + 
+        link_to($2.strip, forum_forum_topic_path(@forum, topic), options)
+      else
+        link_to(topic.title, forum_forum_topic_path(@forum, topic), options)
+      end
+    end
+
+    #------------------------------------------------------------------------------
+    def modify_history(function, name, path, params_hash=nil)
+      state = "null"
+      query_string = "?"
+      if params_hash
+         state = params_hash.to_json
+         params_hash.each { |k,v| query_string << "#{k}=#{v}&" }
+      end
+      query_string = query_string.chop
+      %{history.#{function}(#{state}, '#{j(name)}', '#{j(path+query_string)}');}.html_safe
+    end
+
+    #------------------------------------------------------------------------------
+    def edited_on_tag(post)
+      if (post.updated_at - post.created_at > 5.minutes)
+        %{<span class='date'>#{I18n.t 'fms.post_edited', :when => time_ago_in_words(post.updated_at)}</span>}.html_safe
+      end
+    end
+
+    # used to know if a topic has changed since we read it last
+    #------------------------------------------------------------------------------
+    def recent_topic_activity(topic)
+      return false unless user_signed_in?
+      return topic.last_updated_at > ((session[:forum_topics] ||= {})[topic.id] || last_active)
+    end 
+
+    # used to know if a forum has changed since we read it last
+    #------------------------------------------------------------------------------
+    def recent_forum_activity(forum)
+      return false unless user_signed_in? && forum.recent_topic
+      return forum.recent_topic.last_updated_at > ((session[:forums] ||= {})[forum.id] || last_active)
+    end
+
+    #------------------------------------------------------------------------------
+    def last_active
+      session[:last_active] ||= Time.now.utc
+    end
+
+    # Ripe for optimization
+    #------------------------------------------------------------------------------
+    def voice_count
+      pluralize ForumSite.site.forum_topics.to_a.sum { |t| t.voice_count }, 'voice'
+    end
+
+    #------------------------------------------------------------------------------
+    def feed_icon_tag(title, url)
+      # (@feed_icons ||= []) << { :url => url, :title => title }
+      # link_to image_tag('feed-icon.png', :size => '14x14', :alt => "Subscribe to #{title}"), url
+    end
+
+    #------------------------------------------------------------------------------
+    def forum_crumbs(forum = nil)
+      seperator  = "<span class='arrow'><i class='icon-angle-right'></i></span>".html_safe
+      out        = "".html_safe
+      out       += link_to(I18n.t('fms.forums'), forum_root_path) + seperator
+      if forum
+        out     += link_to(forum.name, forum_path(forum))
+        page     = session[:forum_page] ? session[:forum_page][forum.id] : nil
+        if page and page != 1
+          out   += "<small style='color:#ccc'>(".html_safe
+          out   += link_to(I18n.t('fms.page_nr'), forum_path(:id => forum, :page => page))
+          out   += ")</small>".html_safe
+        end
+        out     += seperator
+      end
+      return out
+    end
+
+    #------------------------------------------------------------------------------
+    def forum_topic_icon(forum_topic)
+      if recent_topic_activity(forum_topic)
+        style       = "style='color:green'"
+        recent_txt  = I18n.t('fms.views_forums.recent_activity')
+      else
+        stlye       = ''
+        recent_txt  = I18n.t('fms.views_forums.no_recent_activity')
+      end
+      if forum_topic.locked?
+        "<i class='icon-lock icon-large' #{style} title='#{I18n.t('fms.views_forums.comma_locked_topic')}'></i>".html_safe
+      else
+        "<i class='icon-comments icon-large' #{style} title='#{recent_txt}'></i>".html_safe
+      end
+    end
+
+    #------------------------------------------------------------------------------
+    def forum_comment_user_state(forum_comment)
+      if forum_comment.user.is_admin?
+        I18n.t 'fms.user_is_administrator', :default => 'Administator'
+      elsif can?(:moderate, forum_comment.forum_topic.forum)
+        I18n.t 'fms.user_is_moderator', :default => 'Moderator'
+      elsif forum_comment.user.suspended?
+        forum_comment.user.state
+      end
+    end
+  end
+end

data/app/mailers/forum_notification_mailer.rb

@@ -0,0 +1,27 @@
+class ForumNotificationMailer < DmCore::SiteMailer
+  
+  helper  DmCore::LiquidHelper
+  helper  DmCore::UrlHelper
+  helper  DmCore::AccountHelper
+
+  #------------------------------------------------------------------------------
+  def follower_notification(user, topic, comment_list)
+    account         = topic.account
+    @subject        = "Commets: #{topic.title}"
+    @recipients     = user.email
+    @topic          = topic
+    @comment_list   = comment_list
+    @topic_link     = dm_forum.forum_forum_topic_url(topic.forum.slug, topic.slug, locale: I18n.locale)
+    @forum_link     = dm_forum.forum_show_url(topic.forum.slug, locale: I18n.locale)
+    
+    headers = { "Return-Path" => account.preferred_smtp_from_email }
+    mail( from: account.preferred_smtp_from_email,
+          reply_to: account.preferred_smtp_from_email,
+          to: @recipients, subject: @subject, 
+          theme: account.account_prefix) do |format|
+      format.text { render "layouts/email_templates/forum_notification.text.erb" }
+      format.html { render "layouts/email_templates/forum_notification.html.erb" }
+    end
+  end
+
+end

data/app/models/dm_forum/concerns/ability.rb

@@ -0,0 +1,50 @@
+# Wrap forum specific CanCan rules.  Should be included in the main app's
+# Ability class.
+# NOTE:  When checking abilities, don't check for Class level abilities,
+# unless you don't care about the instance level.  For example, don't
+# use both styles
+#   can? :moderate, Forum
+#   can? :moderate, @forum
+# In this case, if you need to check the class level, then use specific
+#    current_user.has_role? :moderator, Forum
+#------------------------------------------------------------------------------
+
+module DmForum
+  module Concerns
+    module Ability
+      def dm_forum_abilities(user)
+        if user
+          #--- Admin
+          if user.has_role?(:forum_manager)
+            can :manage_forums, :all
+            can :access_admin, :all
+          end
+
+          #--- Forum
+          can(:read, Forum)   { |forum| forum.can_be_read_by?(user) }
+          can(:reply, Forum)  { |forum| forum.can_be_replied_by?(user) }
+          can :moderate, Forum, :id => Forum.published.with_role(:moderator, user).map(&:id)
+          
+          #--- Comment
+          can :edit, ForumComment, :user_id => user.id
+        else
+          #--- can only read/see public forums when not logged in
+          can(:read, Forum)   { |forum| forum.can_be_read_by?(user) }
+        end
+      end
+    end
+  end
+end
+
+#------------------------------------------------------------------------------
+# The abilities get basically compiled.  So if you use
+#
+#    can :moderate, Forum, :id => Forum.with_role(:moderator, user).map(&:id)
+#
+# this will execute the Forum.with_role query once during Ability.new.  However
+#
+#    can :moderate, Forum do |forum|
+#      user.has_role? :moderator, forum
+#    end
+#
+# this will execute the has_role? block on each call to can?

data/app/models/dm_forum/concerns/user.rb

@@ -0,0 +1,37 @@
+# Extends the User model with hooks for the Forum
+#------------------------------------------------------------------------------
+module DmForum
+  module Concerns
+    module User
+      extend ActiveSupport::Concern
+
+      # 'included do' causes the included code to be evaluated in the
+      # conext where it is included (post.rb), rather than be 
+      # executed in the module's context (blorgh/concerns/models/post).
+      #------------------------------------------------------------------------------
+      included do
+
+        has_many :forum_comments, {:as => :commentable, :dependent => :delete_all}
+        has_many :forum_topics, -> { order("#{ForumTopic.table_name}.created_at desc") }
+
+        #------------------------------------------------------------------------------
+        def available_forums
+          @available_forums ||= site.ordered_forums - forums
+        end
+      end
+
+      #------------------------------------------------------------------------------
+      module ClassMethods
+      end
+
+    end
+  end
+end
+
+# {todo} non-working attempts to include this automatically if the forum engine is being used,
+# so that it doesn't have to be added to the application's user.rb file by hand
+#------------------------------------------------------------------------------
+# class User
+#   include DmForum::Concerns::User
+# end
+# User.send :include, DmForum::Concerns::User

data/app/models/dm_forum/permitted_params.rb

@@ -0,0 +1,38 @@
+module DmForum
+  module PermittedParams
+
+    #------------------------------------------------------------------------------
+    def forum_site_params
+      params.require(:forum_site).permit! if can? :manage_forums, :all
+    end
+
+    #------------------------------------------------------------------------------
+    def forum_category_params
+      params.require(:forum_category).permit! if can? :manage_forums, :all
+    end
+
+    #------------------------------------------------------------------------------
+    def forum_params
+      params.require(:forum).permit! if can? :manage_forums, :all
+    end
+
+    #------------------------------------------------------------------------------
+    def forum_topic_params
+      if can? :manage_forums, :all
+        params.require(:forum_topic).permit!
+      else
+        params.require(:forum_topic).permit(:title, :body)
+      end
+    end
+
+    #------------------------------------------------------------------------------
+    def forum_comment_params
+      if can? :manage_forums, :all
+        params.require(:forum_comment).permit!
+      else
+        params.require(:forum_comment).permit(:title, :body)
+      end
+    end
+
+  end
+end

data/app/models/forum.rb

@@ -0,0 +1,74 @@
+class Forum < ActiveRecord::Base
+  include DmCore::Concerns::PublicPrivate
+
+  self.table_name             = 'fms_forums'
+
+  # --- FriendlyId
+  extend FriendlyId
+  friendly_id                 :name, use: :scoped, scope: :account_id
+  validates_presence_of       :slug
+  before_save                 :normalize_slug
+
+  resourcify
+
+  include RankedModel
+  ranks                       :row_order, :with_same => :forum_category_id
+  
+  belongs_to                  :forum_site
+  belongs_to                  :forum_category, :class_name => 'ForumCategory'
+  has_many                    :forum_topics, -> { order('sticky desc, last_updated_at desc') }, :dependent => :destroy
+  belongs_to                  :owner, :polymorphic => true
+
+  # this is used to see if a forum is "fresh"... we can't use topics because it puts
+  # stickies first even if they are not the most recently modified
+  has_many                    :recent_topics, -> { includes(:user).order('last_updated_at DESC') }, :class_name => 'ForumTopic'
+  has_one                     :recent_topic,  -> { order('last_updated_at DESC') },                 :class_name => 'ForumTopic'
+
+  default_scope               { where(account_id: Account.current.id).order(:row_order) }
+  scope                       :published, -> { where(:published => true) }
+
+  # --- validations
+  validates_presence_of       :name
+
+  # If user set slug sepcifically, we need to make sure it's been normalized
+  #------------------------------------------------------------------------------
+  def normalize_slug
+    self.slug = normalize_friendly_id(self.slug)
+  end
+  
+  # regenerate slug if it's blank
+  #------------------------------------------------------------------------------
+  def should_generate_new_friendly_id?
+    self.slug.blank?
+  end
+
+  # use babosa gem (to_slug) to allow better handling of multi-language slugs
+  #------------------------------------------------------------------------------
+  def normalize_friendly_id(text)
+    text.to_s.to_slug.normalize.to_s
+  end
+  
+  #------------------------------------------------------------------------------
+  def followed_topics(user)
+    user.following.following_by_type('ForumTopic').where(forum_id: self.id)
+  end
+
+  #------------------------------------------------------------------------------
+  def to_s
+    name
+  end
+  
+  # Send comment notifications to any followers
+  #------------------------------------------------------------------------------
+  def self.notify_followers(start_time, end_time = Time.now)
+    comments          = Comment.where(commentable_type: 'ForumTopic', created_at: start_time..end_time)
+    comments_by_topic = comments.group_by {|i| i.commentable_id }
+    comments_by_topic.each do |topic_id, topic_comments|
+      forum_topic = ForumTopic.find(topic_id)
+      followers   = forum_topic.followers
+      followers.each do |follower|
+        email =  ForumNotificationMailer.follower_notification(follower.user, forum_topic, topic_comments).deliver_now
+      end
+    end
+  end
+end

data/app/models/forum_category.rb

@@ -0,0 +1,14 @@
+class ForumCategory < Category
+
+  has_many     :forums, :dependent => :destroy
+
+  # Are any of the forums readable by this user? One positive is all need...
+  #------------------------------------------------------------------------------
+  def any_readable_forums?(user)
+    if user && user.is_admin?
+      true
+    else
+      forums.any? { |f| f.can_be_read_by?(user) }
+    end
+  end
+end

data/app/models/forum_comment.rb

@@ -0,0 +1,93 @@
+class ForumComment < Comment
+
+  #--- counter cache is set in the Comment model
+  belongs_to              :forum_topic, :polymorphic => true, :foreign_key => :commentable_id, :foreign_type => :commentable_type
+
+  #--- update counter cache in forum
+  after_create            :increment_forum_counter_cache
+  after_destroy           :decrement_forum_counter_cache
+
+  default_scope           { where(account_id: Account.current.id) }
+
+  validates_presence_of   :user_id, :body
+  validate                :topic_is_not_locked
+
+  after_create            :update_cached_fields
+  after_update            :update_cached_fields
+  after_destroy           :update_cached_fields
+
+  self.per_page = 10
+
+  # For a forum topic, we have one root comment, which is the body of the topic.
+  # All other comments are either children or siblings
+  #------------------------------------------------------------------------------
+  def self.create_comment(forum_topic, body, user, parent_comment = nil)
+    unless parent_comment
+      #--- if it's the first comment, make it the root, otherwise it's a child
+      parent_comment    = (forum_topic.forum_comments.empty? ? nil : forum_topic.forum_comments[0].root)
+    end
+    forum_topic.forum_comments.build(:body => body).tap do |comment|
+      comment.user      = user
+      comment.parent    = parent_comment
+      comment.save
+    end
+  end
+
+  #------------------------------------------------------------------------------
+  def self.search(query, options = {})
+    #--- (Beast) had to change the other join string since it conflicts when we bring parents in
+    options[:conditions] ||= ["LOWER(#{ForumComment.table_name}.body) LIKE ?", "%#{query}%"] unless query.blank?
+    options[:select]     ||= "#{ForumComment.table_name}.*, #{ForumTopic.table_name}.title as topic_title, f.name as forum_name"
+    options[:joins]      ||= "inner join #{ForumTopic.table_name} on #{ForumComment.table_name}.topic_id = #{ForumTopic.table_name}.id " + 
+                             "inner join #{Forum.table_name} as f on #{ForumTopic.table_name}.forum_id = f.id"
+    options[:order]      ||= "#{ForumComment.table_name}.created_at DESC"
+    options[:count]      ||= {:select => "#{ForumComment.table_name}.id"}
+    paginate options
+  end
+
+  #------------------------------------------------------------------------------
+  def self.search_monitored(user_id, query, options = {})
+    #--- (Beast) Same as above, but select only posts in topics monitored by the given user
+    # [todo]
+    # options[:conditions] ||= ["LOWER(#{ForumComment.table_name}.body) LIKE ?", "%#{query}%"] unless query.blank?
+    # options[:select]     ||= "#{ForumComment.table_name}.*, #{ForumTopic.table_name}.title as topic_title, f.name as forum_name"
+    # options[:joins]      ||= "inner join #{ForumTopic.table_name} on #{ForumComment.table_name}.topic_id = #{ForumTopic.table_name}.id " + 
+    #                          "inner join #{Forum.table_name} as f on #{ForumTopic.table_name}.forum_id = f.id " +
+    #                          "inner join #{Monitorship.table_name} as m on #{ForumComment.table_name}.topic_id = m.topic_id AND " +
+    #                          "m.user_id = #{user_id} AND m.active != 0"
+    # options[:order]      ||= "#{ForumComment.table_name}.created_at DESC"
+    # options[:count]      ||= {:select => "#{ForumComment.table_name}.id"}
+    # paginate options
+  end
+
+  #------------------------------------------------------------------------------
+  def forum_name
+    forum_topic.forum.name
+  end
+
+protected
+
+  #------------------------------------------------------------------------------
+  def update_cached_fields
+    forum_topic.update_cached_comment_fields(self) unless forum_topic.nil?
+  end
+
+  #------------------------------------------------------------------------------
+  def topic_is_not_locked
+    errors.add(:base, "Topic is locked") if forum_topic && forum_topic.locked? && forum_topic.comments_count > 0
+  end
+
+private
+
+  # Since we can't have a belongs_to to the specific forum, update the comment
+  # counter cache by hand
+  #------------------------------------------------------------------------------
+  def increment_forum_counter_cache
+    Forum.increment_counter( 'comments_count', self.forum_topic.forum.id )
+  end
+
+  def decrement_forum_counter_cache
+    Forum.decrement_counter( 'comments_count', self.forum_topic.forum.id ) unless self.forum_topic.nil?
+  end
+
+end

data/app/models/forum_site.rb

@@ -0,0 +1,27 @@
+class ForumSite < ActiveRecord::Base
+  class UndefinedError < StandardError; end
+
+  self.table_name           = 'fms_forum_sites'
+
+  has_many                  :forums,         -> { where(is_public: true) }
+  has_many                  :all_forums,     :class_name => 'Forum'
+  has_many                  :forum_topics,   :through => :forums
+  has_many                  :forum_comments, :through => :forums
+
+  default_scope             { where(account_id: Account.current.id) }
+
+  attr_readonly             :comments_count, :forum_topics_count, :users_online
+
+
+  # There is only one forum site per account
+  #------------------------------------------------------------------------------
+  def self.site
+    ForumSite.first
+  end
+  
+  #------------------------------------------------------------------------------
+  def ordered_forums
+    forums
+  end
+
+end