zen 0.2.5 → 0.2.6

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

@@ -9,18 +9,18 @@ module Comments
     #
     # @author Yorick Peterse
     # @since  0.1
-    # 
+    #
     class CommentsForm < Zen::Controller::FrontendController
       include ::Comments::Model
-      
+
       map('/comments-form')
-      
+
       before_all do
         csrf_protection(:save) do
           respond(lang('zen_general.errors.not_authorized'), 403)
         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.
@@ -32,19 +32,22 @@ module Comments
         Zen::Language.load('comments')
 
         comment = Comment.new
-        post    = request.params.dup
-        entry   = ::Sections::Model::SectionEntry[h(post['section_entry']).to_i]
-        
+        post    = request.subset(
+          :section_entry, :user_id, :comment, :name, :website, :email
+        )
+
+        entry = ::Sections::Model::SectionEntry[post['section_entry']]
+
         # 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)
@@ -52,83 +55,65 @@ module Comments
             end
           end
         end
-        
+
         comment.section_entry_id = entry.id
-        
+
         # Validate the section entry
         if entry.nil?
-          flash[:error] = lang('comments.errors.invalid_entry')
+          message(:error, lang('comments.errors.invalid_entry'))
           redirect_referrer
         end
-        
+
         section = entry.section
-        
+
         # Comments allowed?
         if section.comment_allow == false
-          flash[:error] = lang('comments.errors.comments_not_allowed')
+          message(:error, lang('comments.errors.comments_not_allowed'))
           redirect_referrer
         end
-        
+
         # Comments require an account?
         if section.comment_require_account == true and session[:user].nil?
-          flash[:error] = lang('comments.errors.comments_require_account')
+          message(:error, lang('comments.errors.comments_require_account'))
           redirect_referrer
         end
-        
+
         # Require moderation?
         if section.comment_moderate == true
           comment.status = 'closed'
         end
-        
+
         # Require anti-spam validation?
-        if ::Zen::Settings[:enable_antispam] == '1'
-          # Validate the comment
-          api_key = ::Zen::Settings[:defensio_key]
-          
-          if api_key.nil?
-            flash[:error] = lang('comments.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] = lang('comments.errors.defensio_status')
-            redirect_referrer
-          end
-          
+        if ::Zen.settings[:enable_antispam] == '1'
+          engine = ::Zen.settings[:anti_spam_system].to_sym
+          spam   = plugin(:anti_spam, engine, nil, nil, nil, post['comment'])
+
           # Time to validate the Defensio response
-          if response['allow'] == true and response['spaminess'] <= 0.85
+          if spam === false
             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] = lang('comments.success.moderate')
+            message(:success, lang('comments.success.moderate'))
           else
-            flash[:success] = lang('comments.success.new')
+            message(:success, lang('comments.success.new'))
           end
-        rescue
-          flash[:error] = lang('comments.errors.new')
+        rescue => e
+          Ramaze::Log.error(e.inspect)
+          message(:error, lang('comments.errors.new'))
         end
-        
+
         redirect_referrer
       end
     end

data/lib/zen/package/comments/lib/comments/language/en/comments.yml

@@ -13,14 +13,20 @@ labels:
   name               : 'Name'
   created_at         : 'Created'
   updated_at         : 'Updated'
-  defensio_signature : 'Defensio Signature'
+  defensio           : 'Defensio'
+  anti_spam_system   : 'Anti-spam system'
   open               : 'Open'
   closed             : 'Closed'
   spam               : 'Spam'
+  defensio_key       : 'Defensio key'
 
 messages:
   no_comments: 'No comments have been added yet.'
 
+placeholders:
+  anti_spam_system : 'The anti-spam system to use for validating comments.'
+  defensio_key     : 'The API key for the Defensio anti-spam system.'
+
 success:
   new      : 'The new comment has been created.'
   save     : 'The comment has been modified.'
@@ -34,8 +40,6 @@ errors:
   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."
-  no_api_key           : 'You need to specify an API key for the Defensio system in your settings panel.'
-  defensio_status      : 'The comment could not be saved due to a problem with the Defensio server.'
 
 buttons:
   delete : 'Delete selected comments'

data/lib/zen/package/comments/lib/comments/language/nl/comments.yml

@@ -0,0 +1,48 @@
+---
+titles:
+  index: 'Reacties'
+  edit : 'Reactie aanpassen'
+
+labels:
+  id              : '#'
+  website         : 'Website'
+  entry           : 'Sectie artikelen'
+  email           : 'Email'
+  status          : 'Status'
+  comment         : 'Reactie'
+  name            : 'Naam'
+  created_at      : 'Aangemaakt'
+  updated_at      : 'Aangepast'
+  defensio        : 'Defensio'
+  anti_spam_system: 'Anti-spam systeem'
+  open            : 'Open'
+  closed          : 'Gesloten'
+  spam            : 'Spam'
+  defensio_key    : 'Defensio sleutel'
+
+messages:
+  no_comments: 'Er zijn nog geen reacties toegevoegd.'
+
+placeholders:
+  anti_spam_system: 'Het anti-spam systeem dat gebruikt moet worden voor het verifiëren 
+van reacties.'
+  defensio_key: 'De API sleutel voor het Defensio anti-spam systeem.'
+
+success:
+  new     : 'De reactie is aangemaakt.'
+  save    : 'De reactie is aangepast.'
+  delete  : 'Alle geselecteerde reacties zijn verwijderd.'
+  moderate: 'De reactie moet eerst worden goedgekeurd door een beheerder voordat het kan 
+worden weergegeven'
+
+errors:
+  new                 : 'De reactie kon niet worden aangemaakt.'
+  save                : 'De reactie kon niet worden aangepast.'
+  delete              : 'De reactie met ID #%s kon niet worden verwijderd.'
+  no_delete           : 'U moet ten minste 1 reactie specificeren om te verwijderen.'
+  invalid_entry       : 'Het gespecificeerde artikel is ongeldig.'
+  comments_not_allowed: 'Reacties zijn niet toegestaan voor deze sectie.'
+
+buttons:
+  delete: 'Geselecteerde reacties verwijderen'
+  save  : 'Reactie opslaan'

data/lib/zen/package/comments/lib/comments/model/comment.rb

@@ -31,7 +31,10 @@ module Comments
       #
       def validate
         validates_presence :comment
-        validates_presence :email
+
+        if user_id.nil?
+          validates_presence :email
+        end
       end
 
       ##
@@ -53,6 +56,44 @@ module Comments
           'spam'   => lang('comments.labels.spam') 
         }
       end
-    end
-  end
-end
+
+      ##
+      # Hook run before creating a new comment.
+      #
+      # @author Yorick Peterse
+      # @since  0.2.6
+      #
+      def before_create
+        super
+        sanitize
+      end
+
+      ##
+      # Hook run before saving an existing comment.
+      #
+      # @author Yorick Peterse
+      # @since  0.2.6
+      #
+      def before_save
+        super
+        sanitize
+      end
+
+      ##
+      # Cleans all the input data of nasty stuff.
+      #
+      # @author Yorick Peterse
+      # @since  0.2.6
+      #
+      def sanitize
+        [:name, :website, :email, :comment].each do |field|
+          got = send(field)
+
+          if !got.nil?
+            send("#{field}=", Loofah.fragment(got).scrub!(:whitewash).scrub!(:nofollow).to_s)
+          end
+        end
+      end
+    end # Comment
+  end # Model
+end # Comments

data/lib/zen/package/comments/lib/comments/plugin/anti_spam.rb

@@ -0,0 +1,152 @@
+#:nodoc:
+module Comments
+  #:nodoc:
+  module Plugin
+    ##
+    # A plugin that can be used to verify a comment against an external (or internal)
+    # service to see if it's spam or ham.
+    #
+    # ## Usage
+    #
+    #     plugin(:anti_spam, engine, author, email, url, comment)
+    #
+    # Note that all variables are required. This is because certain anti-spam systems may
+    # verify the name of the author or the entered Email address besides just the comment.
+    # When using Defensio you're only required to set the comment:
+    #
+    #     plugin(:anti_spam, :defensio, nil, nil, nil, 'Hello, this is a comment.')
+    #
+    # ## Supported Systems
+    #
+    # Currently the plugin only supports Defensio, this engine requires the setting
+    # "defensio_key" to contain a valid Defensio API key.
+    #
+    # ## Adding Systems
+    #
+    # Adding a system is done in two steps. First you should update the hash
+    # Comments::PLugin::AntiSpam::Registered so that it includes your system. The keys of
+    # this hash are symbols that match the name of the engine used when calling the
+    # plugin() method. The values are the Gems to require.
+    #
+    # Once this has been done you should add a method to the class
+    # Comments::Plugin::AntiSpam who's name matches the key set in the Registered hash. If
+    # your anti-spam solution is called "cake" then you'd do something like the following:
+    #
+    #     Comments::Plugin::AntiSpam::Registered[:cake] = 'cake-gem'
+    #
+    #     module Comments
+    #       module Plugin
+    #         class AntiSpam
+    #           def cake
+    #
+    #           end
+    #         end
+    #       end
+    #     end
+    #
+    # The return value of the method added should be a boolean, true for spam and false
+    # for ham. 
+    #
+    # @author Yorick Peterse
+    # @since  0.2.6
+    #
+    class AntiSpam
+      include ::Zen::Plugin::Helper
+
+      ##
+      # Hash containing all the supported anti-spam engines and their Gems to load.
+      #
+      # @author Yorick Peterse
+      # @since  0.2.6
+      #
+      Registered = {
+        :defensio => 'defensio',
+      }
+
+      ##
+      # Creates a new instance of the plugin and saves the passed parameters.
+      #
+      # @author Yorick Peterse
+      # @since  0.2.6
+      # @param  [Symbol] engine The anti-spam engine to use.
+      # @param  [String] author The name of the person that wrote the comment.
+      # @param  [String] email The email address of the author.
+      # @param  [String] url The website of the author (if any).
+      # @param  [String] comment The comment.
+      #
+      def initialize(engine, author, email, url, comment)
+        @engine, @author, @email, @url, @comment = engine, author, email, url, comment
+
+        validate_type(engine, :engine, [Symbol])
+
+        # Load the correct gem
+        if !Registered.key?(@engine) or !respond_to?(@engine)
+          raise(::Zen::PluginError, "The anti-spam engine \"#{@engine}\" is invalid")
+        end
+
+        begin
+          require Registered[@engine]
+        rescue ::LoadError
+          raise(
+            ::Zen::PluginError, 
+            "You need to install the gem \"#{Registered[@engine]}\" in order to " + 
+              "use the anti-spam engine \"#{@engine}\""
+          )
+        end
+      end
+
+      ##
+      # Validates the comment to see if it's spam or ham. 
+      #
+      # @author Yorick Peterse
+      # @since  0.2.6
+      # @return [TrueClass/FalseClass]
+      #
+      def call
+        return send(@engine)
+      end
+
+      ##
+      # Validates the comment using the Defensio anti-spam system.
+      #
+      # @author Yorick Peterse
+      # @since  0.2.6
+      # @return [TrueClass/FalseClass]
+      #
+      def defensio
+        spam = true
+
+        if !::Zen.settings.key?(:defensio_key)
+          raise(::Zen::PluginError, "The setting \"defensio_key\" is missing")
+        end
+
+        api_key = ::Zen.settings[:defensio_key]
+
+        if api_key.nil? or api_key.empty?
+          raise(
+            ::Zen::PluginError, 
+            "You need to specify an API key for the defensio system"
+          )
+        end
+
+        client           = ::Defensio.new(api_key)
+        status, response = client.post_document(
+          :content  => @comment,
+          :platform => 'zen',
+          :type     => 'comment'
+        )
+
+        # Not likely to happen but just in case we'll flag the comment as spam
+        return spam if status != 200
+
+        if response['allow'] === true and response['spaminess'] <= 0.85
+          spam = false
+        else
+          spam = true
+        end
+
+        return spam
+      end
+    end # AntiSpam
+  end # Plugin
+end # Comments