radiant-comments-extension 0.0.6

data/lib/mollom.rb

@@ -0,0 +1,246 @@
+require 'xmlrpc/client'
+require 'openssl'
+require 'base64'
+
+# Mollom API requires this to change, but this gives a warning!
+# XMLRPC::Client::USER_AGENT = "Ruby Mollom/0.1"
+
+class Mollom
+  API_VERSION = '1.0'
+  STATIC_SERVER_LIST = [{:proto => 'http', :host => 'xmlrpc3.mollom.com'},
+                        {:proto => 'http', :host => 'xmlrpc2.mollom.com'},
+                        {:proto => 'http', :host => 'xmlrpc1.mollom.com'}].freeze
+  
+  module Errors
+    Standard = 1000
+    Refresh = 1100
+    TooBusy = 1200
+  end
+
+  attr_accessor :private_key, :public_key
+
+  # Creates a new Mollom object. Takes +private_key+ and +public_key+ as keys.
+  # 
+  #   Mollom.new(:private_key => 'qopzalnzanzajlazjna', :public_key => 'aksakzaddazidzaodjaz')
+  #   # => #<Mollom:0x5b6454 @public_key="aksakzaddazidzaodjaz", @private_key="qopzalnzanzajlazjna">
+  
+  def initialize(options = {})
+    @private_key = options[:private_key]
+    @public_key = options[:public_key]
+  end
+
+  # Checks the content whether it is spam, ham (not spam), or undecided, and gives a quality assessment of the content.
+  # Possible content keys are:
+  #  session_id     # => If you allready have a session_id
+  #  post_title     # => The title
+  #  post_body      # => The main content of the post.
+  #  author_name    # => The name of the post author
+  #  author_url     # => The url the author enters
+  #  author_mail    # => The author's email address
+  #  author_ip      # => The author's IP address
+  #  author_openid  # => The author's OpenID
+  #  author_id      # => The author's ID
+  #
+  # Only the +post_body+ key is required, all other keys are optional.
+  # This function returns a ContentResponse object.
+  #
+  #  response = mollom.check_content :post_title => 'Mollom rules!', 
+  #                                  :post_body => 'I think that mollom is so cool!', 
+  #                                  :author_name => 'Jan De Poorter', 
+  #                                  :author_url => 'http://www.openminds.be'
+  #  response.spam? # => false
+  #  response.ham?  # => true
+  def check_content(content = {})
+    return ContentResponse.new(send_command('mollom.checkContent', content))
+  end
+
+  # Requests an Image captcha from Mollom. It takes the optional <tt>session_id</tt> and <tt>author_ip</tt> keys, if you allready have a session.
+  # It returns a hash with the URL where the captcha can be found, and the session_id, to keep track of the current session (Needed later in <tt>Mollom#check_captcha</tt>)
+  #
+  #  captcha = mollom.image_captcha :author_ip => '172.16.0.1'
+  #  captcha['url']        # => http://xmlrpc1.mollom.com:80/a9616e6b4cd6a81ecdd509fa624d895d.png
+  #  captcha['session_id'] # => a9616e6b4cd6a81ecdd509fa624d895d
+  def image_captcha(info = {})
+    return send_command('mollom.getImageCaptcha', info)
+  end
+
+  # Requests an Audio captcha from Mollom. It takes the optional +session_id+ and +author_ip+ keys, if you allready have a session.
+  # It returns a hash with the URL where the captcha can be found, and the session_id, to keep track of the current session (Needed later in <tt>Mollom#check_captcha</tt>)
+  #
+  #  captcha = mollom.audio_captcha :author_ip => '172.16.0.2', :session_id => 'a9616e6b4cd6a81ecdd509fa624d895d'
+  #  captcha['url']        # => http://xmlrpc1.mollom.com:80/a9616e6b4cd6a81ecdd509fa624d895d.mp3
+  #  captcha['session_id'] # => a9616e6b4cd6a81ecdd509fa624d895d
+  def audio_captcha(info = {})
+    return send_command('mollom.getAudioCaptcha', info)
+  end
+
+  # Checks with mollom if the given captcha (by the user) is correct. Takes +session_id+ and +solution+ keys. Both keys are required.
+  # Returns true if the captcha is valid, false if it is incorrect
+  #
+  #  captcha = mollom.image_captcha :author_ip => '172.16.0.1'
+  #  # show to user... input from user
+  #  return = mollom.valid_captcha? :session_id => captcha['session_id'], :solution => 'abcDe9'
+  #  return # => true
+  def valid_captcha?(info = {})
+    return send_command('mollom.checkCaptcha', info)
+  end
+
+  # Standard check to see if your public/private keypair are recognized. Takes no options
+  def key_ok?
+    return send_command('mollom.verifyKey')
+  rescue
+    return false
+  end
+
+  # Gets some statistics from Mollom about your site.
+  #
+  # The type has to be passed. Possible types:
+  #  total_days
+  #  total_accepted
+  #  total_rejected
+  #  yesterday_accepted
+  #  yesterday_rejected
+  #  today_accepted
+  #  today_rejected
+  #
+  #  mollom.statistics :type => 'total_accepted' # => 123
+  def statistics(options = {})
+    return send_command('mollom.getStatistics', options)
+  end
+
+  # Send feedback to Mollom about a certain content. Required keys are +session_id+ and +feedback+. 
+  # 
+  # Feedback can be any of
+  #  spam
+  #  profanity
+  #  low-quality
+  #  unwanted
+  #
+  #  mollom.send_feedback :session_id => 'a9616e6b4cd6a81ecdd509fa624d895d', :feedback => 'unwanted'
+  def send_feedback(feedback = {})
+    return send_command('mollom.sendFeedback', feedback)
+  end
+
+  # Gets a list of servers from Mollom. You should cache this information in your application in a temporary file or in a database. You can set this with Mollom#server_list=
+  # 
+  # Takes an optional parameter +refresh+, which resets the cached value.
+  #
+  #  mollom.server_list
+  #  # => [{:proto=>"http", :host=>"88.151.243.81"}, {:proto=>"http", :host=>"82.103.131.136"}]
+  def server_list(refresh = false)
+    return @server_list if @server_list && !refresh
+    STATIC_SERVER_LIST.each do |static_server|
+      @server_list = get_server_list_from(static_server)
+      return @server_list if @server_list
+    end
+    # Should have returned a server_list here..
+    raise(Error.new("Can't get mollom server-list"))
+  end
+  
+  # Sets the server list used to contact Mollom. This should be used to set the list of cached servers.
+  #
+  # If you try to set a faulty server list, the function will silently fail, so we can get the server-list from Mollom.
+  def server_list=(list)
+    # Check if we get an actual serverlist-array
+    if list.is_a?(Array) && list.all? {|hash| hash.has_key?(:host) && hash.has_key?(:proto) } 
+      @server_list = list
+    end
+  end
+
+  private
+  def get_server_list_from(server)
+    XMLRPC::Client.new(server[:host], "/#{API_VERSION}").call('mollom.getServerList', authentication_hash).collect do |server| 
+        proto, ip = server.split('://')
+        {:proto => proto, :host => ip}
+    end
+  rescue
+    nil
+  end
+  
+  def send_command(command, data = {})
+    server_list.each do |server|
+      begin
+        return XMLRPC::Client.new(server[:host], "/#{API_VERSION}").call(command, data.merge(authentication_hash))
+      # TODO: Rescue more stuff (Connection Timeout and such)
+      rescue XMLRPC::FaultException => error
+        case error.faultCode
+        when Errors::Standard
+          raise Error.new(error.faultString)
+        when Errors::Refresh # Refresh server list please!
+          # we take this one out of our loop
+          raise
+        when Errors::TooBusy # Server is too busy, take the next one
+          next
+        else
+          next
+        end
+      end
+    end
+    raise Mollom::NoAvailableServers
+  rescue XMLRPC::FaultException
+    # We know it is Errors::Refresh
+    server_list(true)
+    retry
+  end
+  
+  # Creates a HMAC-SHA1 Hash with the current timestamp, a nonce, and your private key.
+  def authentication_hash
+    now = Time.now.gmtime.strftime('%Y-%m-%dT%H:%M:%S.000+0000')
+    nonce = Kernel.rand(2**31) # Random signed int
+
+    hash = Base64.encode64(
+      OpenSSL::HMAC.digest(OpenSSL::Digest::SHA1.new, @private_key, "#{now}:#{nonce}:#{@private_key}")
+    ).chomp
+
+    return :public_key=> @public_key, :time => now, :hash => hash, :nonce => nonce
+  end
+
+  class ContentResponse
+    attr_reader :session_id, :quality
+
+    Unknown = 0
+    Ham  = 1
+    Unsure = 2
+    Spam = 3
+
+    # This class should only be initialized from within the +check_content+ command.
+    def initialize(hash)
+      @spam_response = hash["spam"]
+      @session_id = hash["session_id"]
+      @quality = hash["quality"]
+    end
+
+    # Is the content Spam?
+    def spam?
+      @spam_response == Spam
+    end
+
+    # Is the content Ham?
+    def ham?
+      @spam_response == Ham
+    end
+
+    # is Mollom unsure about the content?
+    def unsure?
+      @spam_response == Unsure
+    end
+
+    # is the content unknown?
+    def unknown?
+      @spam_response == Unknown
+    end
+    
+    # Returns 'unknown', 'ham', 'unsure' or 'spam', depending on what the content is.
+    def to_s
+      case @spam_response
+      when Unknown: 'unknown'
+      when Ham: 'ham'
+      when Unsure: 'unsure'
+      when Spam: 'spam'
+      end
+    end
+  end
+  
+  class Error < StandardError; end
+  class NoAvailableServers < Error; end
+end

data/lib/tasks/comments_extension_tasks.rake

@@ -0,0 +1,68 @@
+namespace :radiant do
+  namespace :extensions do
+    namespace :comments do
+      
+      desc "Single task to install and update the Comments extension"
+      task :install => [:environment, :initialize, :migrate, :update]
+      
+      desc "Runs the migration of the Comments extension"
+      task :migrate => :environment do
+        require 'radiant/extension_migrator'
+        if ENV["VERSION"]
+          CommentsExtension.migrator.migrate(ENV["VERSION"].to_i)
+        else
+          CommentsExtension.migrator.migrate
+        end
+      end
+      
+      desc "Copies public assets of the CommentsExtension to the instance public/ directory."
+      task :update => :environment do
+        is_svn_or_dir = proc {|path| path =~ /\.svn/ || File.directory?(path) }
+        puts "Copying assets from CommentsExtension"
+        Dir[CommentsExtension.root + "/public/**/*"].reject(&is_svn_or_dir).each do |file|
+          path = file.sub(CommentsExtension.root, '')
+          directory = File.dirname(path)
+          mkdir_p RAILS_ROOT + directory, :verbose => false
+          cp file, RAILS_ROOT + path, :verbose => false
+        end
+      end
+      
+      desc "Generates the initializer for comment sanitizing"
+      task :initialize do
+        sanitizer_path = File.join(Rails.root, 'config', 'initializers', 'sanitizer.rb')
+        if !File.exist?(sanitizer_path)
+          Rake::Task["radiant:extensions:comments:forced_initialize"].execute
+        end
+      end
+      
+      desc "Regenerates the initializer for comment sanitizing if it does not yet exist"
+      task :forced_initialize do
+        sanitizer_path = File.join(Rails.root, 'config', 'initializers', 'sanitizer.rb')
+        mkdir_p File.dirname(sanitizer_path), :verbose => false
+        File.open(sanitizer_path,'w+') do |file|
+          file.write string = <<FILE
+# The Comments Extension uses this option to clean out unwanted elements from the comments.
+# The example output for each option is the result of sanitization for this text:
+#
+# '<b><a href="http://foo.com/">foo</a></b><img src="http://foo.com/bar.jpg" />'
+#
+# Uncomment one of the options below to choose your preference. By default, RELAXED is used.
+# For more information about your options, please see the Sanitize documentation:
+# http://rgrove.github.com/sanitize/
+
+COMMENT_SANITIZER_OPTION = 
+  Sanitize::Config::RELAXED # Gives you '<b><a href="http://foo.com/">foo</a></b><img src="http://foo.com/bar.jpg" />'
+  # Sanitize::Config::BASIC # Results in '<b><a href="http://foo.com/" rel="nofollow">foo</a></b>'
+  # Sanitize::Config::RESTRICTED # This results in '<b>foo</b>'
+  
+  # Or you may create your own sanitization rules. Uncomment all the lines below and edit them as you need.
+  # {:elements => ['a', 'span'],
+  #  :attributes => {'a' => ['href', 'title'], 'span' => ['class']},
+  #  :protocols => {'a' => {'href' => ['http', 'https', 'mailto']}}}
+FILE
+        end
+        puts "Comment sanitization settings may be found in config/initializers/sanitizer.rb"
+      end
+    end
+  end
+end

data/public/stylesheets/admin/comments.css

@@ -0,0 +1,41 @@
+#comment-nav {
+  float: right;
+  list-style: none;
+  margin: -42px 0 0 96px;
+  padding: 0; }
+  #comment-nav li {
+    display: inline;
+    margin: 0 5px 0 0; }
+  #comment-nav a, #comment-nav span {
+    padding: 5px 5px 5px 25px;
+    background-position: 5px center;
+    background-repeat: no-repeat; }
+  #comment-nav a, #comment-nav a:visited {
+    color: black; }
+  #comment-nav span {
+    border: 1px solid #ffa;
+    background-color: #ffd; }
+  #comment-nav li.all a, #comment-nav li.all span {
+    background-image: url(/images/admin/comments.png); }
+  #comment-nav li.approved a, #comment-nav li.approved span {
+    background-image: url(/images/admin/accept.png); }
+  #comment-nav li.unapproved a, #comment-nav li.unapproved span {
+    background-image: url(/images/admin/error.png); }
+  #comment-nav li.csv a, #comment-nav li.csv span {
+    background-image: url(/images/admin/table_save.png); }
+
+html>body li.all a, html>body li.all span, html>body li.approved a, html>body li.approved span, html>body li.unapproved a, html>body li.unapproved span, html>body li.csv a, html>body li.csv span {
+  *display: inline-block; }
+
+* html li.all a, * html li.all span, * html li.approved a, * html li.approved span, * html li.unapproved a, * html li.unapproved span, * html li.csv a, * html li.csv span {
+  display: inline-block; }
+
+#content tr.comment td.content { color: #333; padding-right: 8px; width: 45%; font-size: 75%; }
+#content tr.comment blockquote.short { display: inline; margin: 0 }
+#content tr.comment blockquote.expanded { display:block; margin: 0; padding: 4px; border: 1px solid #bbc; background-color: #eef; }
+#content tr.comment td.controls, #content tr.comment td.date { white-space: nowrap }
+#content tr.comment.approved { background-color: #efe; }
+#content tr.comment a { color: black; }
+#content tr.comment a:visited { color: black; }
+
+button.delete-unapproved { padding: 5px; font-size: 120%; }

data/radiant-comments-extension.gemspec

@@ -0,0 +1,133 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run the gemspec command
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{radiant-comments-extension}
+  s.version = "0.0.6"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Jim Gay", "Ryan Heneise", "Sean Cribbs", "John Muhl", "Sven Schwyn", "Gerrit Kaiser", "Stephen Lombardo", "Benny Degezelle", "Frank Louwers", "Michael Hale", "Nathaniel Talbott", "John Croisant", "Jon Leighton", "Witter Cheng", "Keith Bingman"]
+  s.date = %q{2010-04-01}
+  s.description = %q{Adds blog-like comment functionality to Radiant.}
+  s.email = %q{jim@saturnflyer.com}
+  s.extra_rdoc_files = [
+    "README.rdoc",
+     "TODO"
+  ]
+  s.files = [
+    ".gitignore",
+     "CHANGELOG",
+     "HELP_admin.markdown",
+     "HELP_designer.markdown",
+     "MIT-LICENSE",
+     "README.rdoc",
+     "Rakefile",
+     "TODO",
+     "VERSION",
+     "app/controllers/admin/comments_controller.rb",
+     "app/controllers/comments_controller.rb",
+     "app/helpers/admin/comments_helper.rb",
+     "app/models/akismet_spam_filter.rb",
+     "app/models/comment.rb",
+     "app/models/comment_mailer.rb",
+     "app/models/mollom_spam_filter.rb",
+     "app/models/simple_spam_filter.rb",
+     "app/models/spam_filter.rb",
+     "app/views/admin/comments/_comment.rhtml",
+     "app/views/admin/comments/_form.rhtml",
+     "app/views/admin/comments/edit.rhtml",
+     "app/views/admin/comments/index.rhtml",
+     "app/views/admin/pages/_comments.rhtml",
+     "app/views/admin/pages/_edit_comments_enabled.rhtml",
+     "app/views/admin/pages/_index_head_view_comments.rhtml",
+     "app/views/admin/pages/_index_view_comments.rhtml",
+     "app/views/comment_mailer/comment_notification.rhtml",
+     "app/views/comments/_comment.rhtml",
+     "app/views/comments/_form.rhtml",
+     "app/views/comments/_new.rhtml",
+     "autotest/discover.rb",
+     "comments_extension.rb",
+     "cucumber.yml",
+     "db/migrate/001_create_comments.rb",
+     "db/migrate/002_create_snippets.rb",
+     "db/migrate/003_change_filter_id_from_integer_to_string.rb",
+     "db/migrate/004_add_approval_columns.rb",
+     "db/migrate/005_add_mollomid_column.rb",
+     "db/migrate/006_move_config_to_migrations.rb",
+     "db/migrate/007_add_preference_for_simple_spamcheck.rb",
+     "features/support/env.rb",
+     "features/support/paths.rb",
+     "lib/akismet.rb",
+     "lib/comment_page_extensions.rb",
+     "lib/comment_tags.rb",
+     "lib/mollom.rb",
+     "lib/radiant-comments-extension.rb",
+     "lib/tasks/comments_extension_tasks.rake",
+     "public/images/admin/accept.png",
+     "public/images/admin/comment_edit.png",
+     "public/images/admin/comments.png",
+     "public/images/admin/comments_delete.png",
+     "public/images/admin/delete.png",
+     "public/images/admin/email.png",
+     "public/images/admin/error.png",
+     "public/images/admin/link.png",
+     "public/images/admin/page_white_edit.png",
+     "public/images/admin/table_save.png",
+     "public/images/admin/tick.png",
+     "public/stylesheets/admin/comments.css",
+     "radiant-comments-extension.gemspec",
+     "spec/controllers/admin/comments_controller_spec.rb",
+     "spec/controllers/admin/comments_routing_spec.rb",
+     "spec/controllers/page_postback_spec.rb",
+     "spec/datasets/comments_dataset.rb",
+     "spec/models/akismet_spam_filter_spec.rb",
+     "spec/models/comment_spec.rb",
+     "spec/models/comment_tags_spec.rb",
+     "spec/models/mollom_spam_filter_spec.rb",
+     "spec/models/simple_spam_filter_spec.rb",
+     "spec/models/spam_filter_spec.rb",
+     "spec/spec.opts",
+     "spec/spec_helper.rb",
+     "test/fixtures/users.yml",
+     "test/integration/comment_enabling_test.rb",
+     "test/test_helper.rb",
+     "test/unit/comment_test.rb"
+  ]
+  s.homepage = %q{http://github.com/saturnflyer/radiant-comments-extension}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.6}
+  s.summary = %q{Comments Extension for Radiant CMS}
+  s.test_files = [
+    "spec/controllers/admin/comments_controller_spec.rb",
+     "spec/controllers/admin/comments_routing_spec.rb",
+     "spec/controllers/page_postback_spec.rb",
+     "spec/datasets/comments_dataset.rb",
+     "spec/models/akismet_spam_filter_spec.rb",
+     "spec/models/comment_spec.rb",
+     "spec/models/comment_tags_spec.rb",
+     "spec/models/mollom_spam_filter_spec.rb",
+     "spec/models/simple_spam_filter_spec.rb",
+     "spec/models/spam_filter_spec.rb",
+     "spec/spec_helper.rb",
+     "test/integration/comment_enabling_test.rb",
+     "test/test_helper.rb",
+     "test/unit/comment_test.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+      s.add_development_dependency(%q<radiant>, [">= 0"])
+    else
+      s.add_dependency(%q<radiant>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<radiant>, [">= 0"])
+  end
+end
+