zen 0.1a

data/lib/zen/packages/comments/lib/comments.rb

@@ -0,0 +1,26 @@
+
+# Load all our classes
+require __DIR__ 'comments/model/comment.rb'
+require __DIR__ 'comments/controller/comments'
+require __DIR__ 'comments/controller/comments_form'
+require __DIR__ 'comments/liquid/comments'
+require __DIR__ 'comments/liquid/comment_form'
+
+Liquid::Template.register_tag('comments'    , Comments::Liquid::Comments)
+Liquid::Template.register_tag('comment_form', Comments::Liquid::CommentForm)
+
+Zen::Package.add do |p|
+  p.type        = 'extension'
+  p.name        = 'Comments'
+  p.author      = 'Yorick Peterse'
+  p.url         = 'http://yorickpeterse.com/'
+  p.version     = '0.1'
+  p.about       = "Allow users to post comments on any given section entry (as long as the section allows it)."
+  p.identifier  = 'com.zen.comments'
+  p.directory   = __DIR__('comments')
+  
+  p.menu = [{
+    :title => "Comments",
+    :url   => "admin/comments"
+  }]
+end

data/lib/zen/packages/comments/lib/comments/controller/comments.rb

@@ -0,0 +1,157 @@
+module Comments
+  module Controllers
+    ##
+    # Controller used for managing comments. Administrations can't actually
+    # add new comments using the backend controller but can edit or delete them.
+    # Comments can be submitted to any section entry as long as the section
+    # allows it. When submitting a comment the user data such as the name and email
+    # will be retrieved from either the users table (if the user is logged in) or
+    # from the form that was submitted.
+    #
+    # @author  Yorick Peterse
+    # @since   0.1
+    #
+    class Comments < Zen::Controllers::AdminController
+      map '/admin/comments'
+      
+      trait :extension_identifier => 'com.zen.comments'
+      
+      include ::Comments::Models
+      
+      before_all do
+        csrf_protection :save, :delete do
+          respond("The specified request can't be executed without a valid CSRF token", 401)
+        end
+      end
+      
+      ##
+      # Constructor method that pre-loads several variables.
+      # 
+      # @author Yorick Peterse
+      # @since  0.1
+      #
+      def initialize
+        super
+        
+        @form_save_url   = '/admin/comments/save'
+        @form_delete_url = '/admin/comments/delete'
+        @comments_lang   = Zen::Language.load 'comments'
+        
+        # Set the page title
+        if !action.method.nil?
+          method = action.method.to_sym
+
+          if @comments_lang.titles.key? method 
+            @page_title = @comments_lang.titles[method]
+          end
+        end
+      end
+    
+      ##
+      # Shows an overview of all posted comments along with their status,
+      # author and so on.
+      # 
+      # @author Yorick Peterse
+      # @since  0.1
+      #
+      def index
+        if !user_authorized?([:read])
+          respond(@zen_general_lang.errors[:not_authorized], 403)
+        end
+        
+        set_breadcrumbs @comments_lang.titles[:index]
+        
+        @comments = Comment.all
+      end
+      
+      ##
+      # Edits an existing comment based on the ID.
+      #
+      # @author Yorick Peterse
+      # @param  [Integer] id The ID of the comment to retrieve so that we can edit it.
+      # @since  0.1
+      #
+      def edit id
+        if !user_authorized?([:read, :update])
+          respond(@zen_general_lang.errors[:not_authorized], 403)
+        end
+        
+        set_breadcrumbs anchor_to(@comments_lang.titles[:index], "admin/comments"), @page_title
+        
+        @comment = Comment[id]
+      end
+      
+      ##
+      # Saves a comment based on the current POST data. Note that this
+      # method won't create a new comment as this can't be done using the backend.
+      #
+      # @author Yorick Peterse
+      # @since  0.1
+      #
+      def save
+        if !user_authorized?([:update])
+          respond(@zen_general_lang.errors[:not_authorized], 403)
+        end
+        
+        # Copy the POST data so we can work with it without messing things up
+        post = request.params.dup
+       
+        # Remove all empty fields
+        post.each do |key, value|
+          post.delete(key) if value.empty?
+        end
+
+        @comment = Comment[post["id"]]
+
+        begin
+          @comment.update(post)
+          notification(:success, @comments_lang.titles[:index], @comments_lang.success[:save])
+        rescue
+          notification(:error, @comments_lang.titles[:index], @comments_lang.errors[:save])
+          
+          flash[:form_errors] = @comment.errors
+        end
+        
+        # Redirect the user to the proper page.
+        if @comment.id
+          redirect "/admin/comments/edit/#{@comment.id}"
+        else
+          redirect_referrer
+        end
+      end
+      
+      ##
+      # Deletes a number of comments based on the comment IDs specified
+      # in the POST array "comment_ids".
+      #
+      # @author Yorick Peterse
+      # @since  0.1
+      #
+      def delete
+        if !user_authorized?([:delete])
+          respond(@zen_general_lang.errors[:not_authorized], 403)
+        end
+        
+        # Obviously we'll require some IDs
+        if !request.params["comment_ids"] or request.params["comment_ids"].empty?
+          notification(:error, @comments_lang.titles[:index], @comments_lang.errors[:no_delete])
+          redirect_referrer
+        end
+        
+        # Delete each section
+        request.params["comment_ids"].each do |id|
+          @comment = Comment[id]
+          
+          begin
+            @comment.delete
+            notification(:success, @comments_lang.titles[:index], @comments_lang.success[:delete] % id)
+          rescue
+            notification(:error, @comments_lang.titles[:index], @comments_lang.errors[:delete] % id)
+          end
+        end
+        
+        redirect_referrer
+      end
+    end 
+  end
+end

data/lib/zen/packages/comments/lib/comments/controller/comments_form.rb

@@ -0,0 +1,135 @@
+module Comments
+  module Controllers
+    ##
+    # Frontend controller for the comments system used for saving user-submitted comments.
+    # When the anti-spam system is enabled Zen will use Defensio to check if the comment is
+    # spam or ham.
+    #
+    # @author Yorick Peterse
+    # @since  0.1
+    # 
+    class CommentsForm < Zen::Controllers::FrontendController
+      include ::Comments::Models
+      
+      map '/comments_form'
+      trait :extension_identifier => 'com.zen.comments'
+      
+      before_all do
+        csrf_protection :save do
+          respond(@zen_general_lang.errors[:csrf], 401)
+        end
+      end
+      
+      ##
+      # Creates a new comment for the section entry. Once the comment has been saved
+      # the user will be redirected back to the previous page.
+      #
+      # @author Yorick Peterse
+      # @since  0.1
+      #
+      def save
+        comments_lang = Zen::Language.load('comments')
+
+        comment = Comment.new
+        post    = request.params.dup
+        entry   = ::Sections::Models::SectionEntry[h(post['section_entry']).to_i]
+        
+        # Remove empty values
+        post.each { |k, v| post.delete(k) if v.empty? }
+        
+        if post.key?('user_id')
+          comment.user_id = post['user_id']
+        end
+        
+        # Set the comment data
+        comment.comment = post['comment']
+        
+        if !post.key?('user_id')
+          ['name', 'website', 'email'].each do |k|
+            if post.key?(k)
+              comment.send("#{k}=", post[k])
+            end
+          end
+        end
+        
+        comment.section_entry_id = entry.id
+        
+        # Validate the section entry
+        if entry.nil?
+          flash[:error] = comments_lang.errors[:invalid_entry]
+          redirect_referrer
+        end
+        
+        section = entry.section
+        
+        # Comments allowed?
+        if section.comment_allow == false
+          flash[:error] = comments_lang.errors[:comments_not_allowed]
+          redirect_referrer
+        end
+        
+        # Comments require an account?
+        if section.comment_require_account == true and session[:user].nil?
+          flash[:error] = comments_lang.errors[:comments_require_account]
+          redirect_referrer
+        end
+        
+        # Require moderation?
+        if section.comment_moderate == true
+          comment.status = 'closed'
+        end
+        
+        # Require anti-spam validation?
+        if session[:settings][:enable_antispam] == '1'
+          # Validate the comment
+          api_key = session[:settings][:defensio_key]
+          
+          if api_key.nil?
+            flash[:error] = comments_lang.errors[:no_api_key]
+            redirect_referrer
+          end
+          
+          defensio         = ::Defensio.new(api_key)
+          status, response = defensio.post_document(
+            :content       => post['comment'],
+            :platform      => "zen",
+            :type          => "comment"
+          )
+          
+          if status != 200
+            flash[:error] = comments_lang.errors[:defensio_status]
+            redirect_referrer
+          end
+          
+          # Time to validate the Defensio response
+          if response['allow'] == true and response['spaminess'] <= 0.85
+            if section.comment_moderate == true
+              comment.status = 'closed'
+            else
+              comment.status = 'open'
+            end
+            
+            comment.defensio_signature = response['signature']
+          else
+            comment.status = 'spam'
+          end
+        end
+        
+        # Save the comment
+        begin
+          comment.save
+          
+          if section.comment_moderate == true
+            flash[:success] = comments_lang.success[:moderate]
+          else
+            flash[:success] = comments_lang.success[:new]
+          end
+        rescue
+          flash[:error]   = comments_lang.errors[:new]
+        end
+        
+        redirect_referrer
+      end
+    end
+  end
+end

data/lib/zen/packages/comments/lib/comments/language/en/comments.rb

@@ -0,0 +1,52 @@
+Zen::Language.translation 'comments' do |item|
+
+  item.titles = {
+    :index  => 'Comments',
+    :edit   => 'Edit Comment'
+  }
+  
+  item.labels = {
+    :id         => '#',
+    :website    => 'Website',
+    :entry      => 'Section entry',
+    :email      => 'Email',
+    :status     => 'Status',
+    :comment    => 'Comment',
+    :name       => 'Name',
+    :created_at => 'Created',
+    :updated_at => 'Updated',
+    :defensio_signature => 'Defensio signature'
+  }
+  
+  item.special = {
+    :status_hash => {'open' => 'Open', 'closed' => 'Closed', 'spam' => 'Spam'}
+  }
+
+  item.messages = {
+    :no_comments    => 'No comments have been added yet.'
+  }
+  
+  item.errors = {
+    :new                  => "Failed to create a new comment.",
+    :save                 => "Failed to save the comment.",
+    :delete               => "Failed to delete the comment with ID #%s",
+    :no_delete            => "You haven't specified any comments to delete.",
+    :invalid_entry        => "The specified section entry is invalid",
+    :comments_not_allowed     => "Comments aren't allowed for this section",
+    :comments_require_account => "This section requires you to be logged in in order to post a comment",
+    :no_api_key               => "You need to specify an API key for the Defension system in your settings panel.",
+    :defensio_status          => "The comment could not be saved due to a problem with the Defensio server."
+  }
+  
+  item.success = {
+    :new      => "The new comment has been created.",
+    :save     => "The comment has been modified.",
+    :delete   => "The comment with ID #%s has been deleted.",
+    :moderate => "The comment has been posted but must be approved by an administrator before it's displayed."
+  }
+  
+  item.buttons = {
+    :delete_comments => 'Delete selected comments',
+    :save_comment    => 'Save comment'
+  }
+end

data/lib/zen/packages/comments/lib/comments/liquid/comment_form.rb

@@ -0,0 +1,97 @@
+require 'ramaze/gestalt'
+
+module Comments
+  module Liquid
+    ##
+    # Describe...
+    #
+    # The following arguments can be used:
+    #
+    # * section_entry
+    # * section_entry_id
+    #
+    # @author Yorick Peterse
+    # @since  0.1
+    #
+    class CommentForm < ::Liquid::Block
+      include ::Zen::Liquid::General
+      include ::Zen::Liquid::ControllerBehavior
+      include ::Ramaze::Helper::CSRF
+      include ::Ramaze::Helper::BlueForm
+      
+      ##
+      # Creates a new instance of the block and passes the tag name,
+      # all additional arguments and the HTML to the constructor method.
+      #
+      # @author Yorick Peterse
+      # @param  [String] tag_name The name of the tag that was called.
+      # @param  [String] arguments All additional arguments passed as a string.
+      # @param  [String] html The HTML inside the block.
+      # @since  0.1
+      #
+      def initialize(tag_name, arguments, html)
+        super
+        
+        @arguments   = parse_key_values(arguments)
+        @args_parsed = false
+      end
+      
+      ##
+      # Renders the tag block.
+      # 
+      # @author Yorick Peterse
+      # @since  0.1
+      #
+      def render(context)
+        if @args_parsed == false
+          @arguments.each do |k, v|
+            v = v.to_s
+            
+            if context.has_key?(v)
+              @arguments[k] = h(context[v])
+            end
+          end
+        end
+        
+        @args_parsed = true
+        g            = Ramaze::Gestalt.new
+        user_html    = ''
+        
+        super(context).each do |h|
+          user_html += h
+        end
+        
+        # Get our section to which this form belongs
+        if @arguments.key?('section_entry')
+          section_entry = ::Sections::Models::SectionEntry[:slug => @arguments['section_entry']]
+        else
+          section_entry = ::Sections::Models::SectionEntry[@arguments['section_entry_id'].to_i]
+        end
+        
+        # Get the section entry's ID
+        if !section_entry.nil?
+          section_entry_id = section_entry.id
+        else
+          section_entry_id = nil
+        end
+        
+        # Get the user's ID if he/she is logged in
+        if !session[:user].nil?
+          user_id = session[:user].id
+        else
+          user_id = nil
+        end
+        
+        g_html = form_for(nil, :method => :post, :action => "/comments_form/save") do |f|
+          f.input_hidden :csrf_token, get_csrf_token
+          f.input_hidden :section_entry, section_entry_id
+          f.input_hidden :user_id, user_id
+          
+          user_html
+        end
+        
+        return g_html
+      end
+    end
+  end
+end