bcms_blog 1.0.0 → 1.1.0

data/LICENSE.txt

@@ -0,0 +1,165 @@
+		   GNU LESSER GENERAL PUBLIC LICENSE
+                       Version 3, 29 June 2007
+
+ Copyright (C) 2007 Free Software Foundation, Inc. <http://fsf.org/>
+ Everyone is permitted to copy and distribute verbatim copies
+ of this license document, but changing it is not allowed.
+
+
+  This version of the GNU Lesser General Public License incorporates
+the terms and conditions of version 3 of the GNU General Public
+License, supplemented by the additional permissions listed below.
+
+  0. Additional Definitions. 
+
+  As used herein, "this License" refers to version 3 of the GNU Lesser
+General Public License, and the "GNU GPL" refers to version 3 of the GNU
+General Public License.
+
+  "The Library" refers to a covered work governed by this License,
+other than an Application or a Combined Work as defined below.
+
+  An "Application" is any work that makes use of an interface provided
+by the Library, but which is not otherwise based on the Library.
+Defining a subclass of a class defined by the Library is deemed a mode
+of using an interface provided by the Library.
+
+  A "Combined Work" is a work produced by combining or linking an
+Application with the Library.  The particular version of the Library
+with which the Combined Work was made is also called the "Linked
+Version".
+
+  The "Minimal Corresponding Source" for a Combined Work means the
+Corresponding Source for the Combined Work, excluding any source code
+for portions of the Combined Work that, considered in isolation, are
+based on the Application, and not on the Linked Version.
+
+  The "Corresponding Application Code" for a Combined Work means the
+object code and/or source code for the Application, including any data
+and utility programs needed for reproducing the Combined Work from the
+Application, but excluding the System Libraries of the Combined Work.
+
+  1. Exception to Section 3 of the GNU GPL.
+
+  You may convey a covered work under sections 3 and 4 of this License
+without being bound by section 3 of the GNU GPL.
+
+  2. Conveying Modified Versions.
+
+  If you modify a copy of the Library, and, in your modifications, a
+facility refers to a function or data to be supplied by an Application
+that uses the facility (other than as an argument passed when the
+facility is invoked), then you may convey a copy of the modified
+version:
+
+   a) under this License, provided that you make a good faith effort to
+   ensure that, in the event an Application does not supply the
+   function or data, the facility still operates, and performs
+   whatever part of its purpose remains meaningful, or
+
+   b) under the GNU GPL, with none of the additional permissions of
+   this License applicable to that copy.
+
+  3. Object Code Incorporating Material from Library Header Files.
+
+  The object code form of an Application may incorporate material from
+a header file that is part of the Library.  You may convey such object
+code under terms of your choice, provided that, if the incorporated
+material is not limited to numerical parameters, data structure
+layouts and accessors, or small macros, inline functions and templates
+(ten or fewer lines in length), you do both of the following:
+
+   a) Give prominent notice with each copy of the object code that the
+   Library is used in it and that the Library and its use are
+   covered by this License.
+
+   b) Accompany the object code with a copy of the GNU GPL and this license
+   document.
+
+  4. Combined Works.
+
+  You may convey a Combined Work under terms of your choice that,
+taken together, effectively do not restrict modification of the
+portions of the Library contained in the Combined Work and reverse
+engineering for debugging such modifications, if you also do each of
+the following:
+
+   a) Give prominent notice with each copy of the Combined Work that
+   the Library is used in it and that the Library and its use are
+   covered by this License.
+
+   b) Accompany the Combined Work with a copy of the GNU GPL and this license
+   document.
+
+   c) For a Combined Work that displays copyright notices during
+   execution, include the copyright notice for the Library among
+   these notices, as well as a reference directing the user to the
+   copies of the GNU GPL and this license document.
+
+   d) Do one of the following:
+
+       0) Convey the Minimal Corresponding Source under the terms of this
+       License, and the Corresponding Application Code in a form
+       suitable for, and under terms that permit, the user to
+       recombine or relink the Application with a modified version of
+       the Linked Version to produce a modified Combined Work, in the
+       manner specified by section 6 of the GNU GPL for conveying
+       Corresponding Source.
+
+       1) Use a suitable shared library mechanism for linking with the
+       Library.  A suitable mechanism is one that (a) uses at run time
+       a copy of the Library already present on the user's computer
+       system, and (b) will operate properly with a modified version
+       of the Library that is interface-compatible with the Linked
+       Version. 
+
+   e) Provide Installation Information, but only if you would otherwise
+   be required to provide such information under section 6 of the
+   GNU GPL, and only to the extent that such information is
+   necessary to install and execute a modified version of the
+   Combined Work produced by recombining or relinking the
+   Application with a modified version of the Linked Version. (If
+   you use option 4d0, the Installation Information must accompany
+   the Minimal Corresponding Source and Corresponding Application
+   Code. If you use option 4d1, you must provide the Installation
+   Information in the manner specified by section 6 of the GNU GPL
+   for conveying Corresponding Source.)
+
+  5. Combined Libraries.
+
+  You may place library facilities that are a work based on the
+Library side by side in a single library together with other library
+facilities that are not Applications and are not covered by this
+License, and convey such a combined library under terms of your
+choice, if you do both of the following:
+
+   a) Accompany the combined library with a copy of the same work based
+   on the Library, uncombined with any other library facilities,
+   conveyed under the terms of this License.
+
+   b) Give prominent notice with the combined library that part of it
+   is a work based on the Library, and explaining where to find the
+   accompanying uncombined form of the same work.
+
+  6. Revised Versions of the GNU Lesser General Public License.
+
+  The Free Software Foundation may publish revised and/or new versions
+of the GNU Lesser General Public License from time to time. Such new
+versions will be similar in spirit to the present version, but may
+differ in detail to address new problems or concerns.
+
+  Each version is given a distinguishing version number. If the
+Library as you received it specifies that a certain numbered version
+of the GNU Lesser General Public License "or any later version"
+applies to it, you have the option of following the terms and
+conditions either of that published version or of any later version
+published by the Free Software Foundation. If the Library as you
+received it does not specify a version number of the GNU Lesser
+General Public License, you may choose any version of the GNU Lesser
+General Public License ever published by the Free Software Foundation.
+
+  If the Library as you received it specifies that a proxy can decide
+whether future versions of the GNU Lesser General Public License shall
+apply, that proxy's public statement of acceptance of any version is
+permanent authorization for you to choose that version for the
+Library.

data/README.markdown

@@ -1,3 +1,114 @@
-# Blog module for BrowserCMS
+# Blog Module for BrowserCMS
+
+A simple blog module that lets users create multiple blogs. 
+
+## Features
+
+* Multiple Blogs - Contributors can create multiple blogs, each of which can have their own sections and pages.
+* Convenient setup - Creating a new blog will automatically create the pages and portlets needed to get started.
+* Tagging - Leverages BrowserCMS' built-in categorization and tagging and authorization framework.
+* Comments - Visitors can leave comments are that can be managed, versioned and moderated. Comments can optionally be moderated.
+* Flexibility - Blogs can be added to any page like any content block.
+* Blog Security - When you create or edit a Blog, you can choose which groups of users can add or edit posts or comments for that blog.
+
+## Installation
+
+The blog module installs like most other BrowserCMS modules (http://guides.browsercms.org/installing_modules.html)
+
+    gem install bcms_blog
+    
+## Set up your application to use the module
+
+### 1. Edit config/environment.rb 
+    
+    config.gem "browsercms"
+    config.gem "bcms_blog"
+    
+### 2. Run the following commands
+  
+    script/generate browser_cms
+    rake db:migrate
+  
+### 3. Edit config/routes.rb
+
+Make sure the routes.rb loads the blog routes.
+
+    map.routes_for_bcms_blog
+    map.routes_for_browser_cms
+
+## Creating a Blog
+
+* To get started, go to the Content Library and choose the Blog module in the left hand menu.
+* Then choose the 'Blog' content type and click Add new content.
+* When you create a Blog content block from the content library, all the structure needed for the blog to run is created for you. This includes a new section, 2 pages, a few page routes and a portlet.
+* Go to the sitemap, and choose the first page in the newly created section (which should match the name of the blog). You will need to publish this page to make it live.
+* To add new Posts, you can go to the Content Library, choose 'Blog -> Blog Post' and Add New Content. Each 'Blog Post' is tied to a particular block.
+* You may also want to add Categories via the Categorization Module.
+
+## Comments
+
+If a Blog is configured for 'Moderate Comments', then when visitors submit them they will be automatically placed in a moderation queue for approval. In the Content Library,
+under 'Blog Comments', these comments will appear in draft status. They can be Published like any other content. (There is current no automatic notification for new comments).
+
+If the blog is set to no moderation, then comments will appear immediately. This obviously increases the likelyhood of spam, but staff can use the Content Library to delete the offending comments like any other content.
+
+## Feeds
+
+This module includes an RSS feeds route that can handle multiple blogs. To expose the RSS autodiscovery link, you can call the feeds\_link\_tag\_for helper in your template header:
+  
+    <%= feeds_link_tag_for "MyBlog" %>
+    
+Where "MyBlog" is the __name__ of the blog.
+
+If your site has multiple blogs, you need to call the helper once for every link you intend to expose:
+
+    <%= feeds_link_tag_for "MyBlog" %>
+    <%= feeds_link_tag_for "MyOtherBlog" %>
+ 
+
+## Security
+
+This module adds some additional level of security around blogs and content that are slightly different from a vanilla BrowserCMS installation. Here's the highlights:
+
+* Blogs - Only CMS Administrators may create or edit blogs themselves. Since creating a new blog has a rippling affect across the site, this keeps that from being inadvertently invoked.
+* Blog Posts - Editors will only be able to see those posts in blogs they are allowed to edit. They will not be able to create posts in blogs they don't have access to.
+* Comments - All Editors may edit/deleted comments. Visitors may add new comments.
+
+## Customization
+
+The module provides a template that is a good starting point for your blog's layout. If you want
+to further customize the look and feel, just copy the file app/views/partials/\_blog_post.html.erb
+on this repository to app/views/partials on your application and modify it to suit your needs.
+
+Keep in mind that both the posts list and individual post pages are handled by the same partial.
+
+## Routes
+
+When each blog is created, there is an additional set of routes that are also created, based on the 'path' of the blog. The initial blog path is based on the name of the blog.
+
+    /:blog_path/:year/:month/:day/:slug
+    /:blog_path/:year/:month/:day
+    /:blog_path/:year/:month
+    /:blog_path/:year
+    /:blog_path/tag/:tag
+    /:blog_path/category/:category
+
+## Architecture
+
+This module will add the following new items to your project.
+
+* New content types for Blogs, Blog Comments and Blog Posts.
+* New portlets for display in a Single Blog post and for showing many blog posts.
+
+## Contributors
+
+Special thanks to some amazing folks from the BrowserCMS community for their work in building the essential features for this module. Here are the MVPs that made this possible:
+
+* Tyler Rick  (http://github.com/TylerRick)
+* Jon Leighton (http://github.com/jonleighton)
+
+## Wishlist Features
+
+* Notifications for Comments - Blogs should have an option to be notified when a new comment is created. This will allow for practical management of comments/spam.
+* Messaging for Moderated comments - If moderation is turned on, users get no feedback about the comment they just left. Ideally, they would get some sort of javascript notice that their comment is awaiting notification.
 
-A simple blog module, consisting of the ability to create one or more blogs, posts and comments.

data/app/controllers/application_controller.rb

@@ -0,0 +1,10 @@
+# Filters added to this controller apply to all controllers in the application.
+# Likewise, all the methods added will be available for all controllers.
+
+class ApplicationController < ActionController::Base
+  helper :all # include all helpers, all the time
+  protect_from_forgery # See ActionController::RequestForgeryProtection for details
+
+  # Scrub sensitive parameters from your log
+  # filter_parameter_logging :password
+end

data/app/controllers/cms/blog_comments_controller.rb

@@ -1,3 +1,3 @@
 class Cms::BlogCommentsController < Cms::ContentBlockController
-  
+
 end

data/app/controllers/cms/blog_posts_controller.rb

@@ -1,2 +1,35 @@
 class Cms::BlogPostsController < Cms::ContentBlockController
-end
+  before_filter :show_no_access_if_none_editable
+  
+  def build_block
+    super
+    ensure_blog_editable
+    @block.author = current_user
+  end
+  
+  def load_block
+    super
+    ensure_blog_editable
+  end
+  
+  def load_blocks
+    super
+    @blocks.delete_if { |b| !b.editable_by?(current_user) }
+  end
+  
+  private
+    
+    # If the current user is not able to edit any blog, just show them a page saying so
+    def show_no_access_if_none_editable
+      if Blog.editable_by(current_user).empty?
+        render :action => "no_access"
+      end
+    end
+    
+    # Ensure the current user can actually edit the blog this blog post is associated with
+    def ensure_blog_editable
+      if @block.blog
+        raise Cms::Errors::AccessDenied unless @block.blog.editable_by?(current_user)
+      end
+    end
+end

data/app/controllers/cms/blogs_controller.rb

@@ -1,2 +1,11 @@
 class Cms::BlogsController < Cms::ContentBlockController
-end
+  check_permissions :administrate, :except => :index
+  
+  def index
+    if current_user.able_to?(:administrate)
+      super
+    else
+      render :action => "admin_only"
+    end
+  end
+end

data/app/controllers/feeds_controller.rb

@@ -0,0 +1,8 @@
+class FeedsController < ApplicationController
+  
+  def index
+    @blog = Blog.find(params[:blog_id])
+    @blog_posts = @blog.posts.published.all(:limit => 10, :order => "published_at DESC")
+  end
+  
+end

data/app/helpers/application_helper.rb

@@ -0,0 +1,3 @@
+# Methods added to this helper will be available to all templates in the application.
+module ApplicationHelper
+end

data/app/helpers/cms/blog_helper.rb

@@ -0,0 +1,17 @@
+module Cms::BlogHelper
+  # We can't call it 'blog_path' because that would conflict with the actual named route method if there's a blog named "Blog".
+  def _blog_path(blog, route_name, route_params)
+    send("#{blog.name_for_path}_#{route_name}_path", route_params)
+  end
+
+  def _blog_post_path(blog_post)
+    send("#{blog_post.route_name}_path", blog_post.route_params)
+  end
+  
+  def feeds_link_tag_for(name)
+    blog = Blog.find_by_name(name)
+    auto_discovery_link_tag(:rss, blog_feeds_url(:blog_id => blog), :title => "#{blog.name}")
+  end
+  
+end
+

data/app/helpers/feeds_helper.rb

@@ -0,0 +1,2 @@
+module FeedsHelper
+end

data/app/models/blog.rb

@@ -1,38 +1,94 @@
 class Blog < ActiveRecord::Base
   acts_as_content_block
-  has_many :posts, :class_name => "BlogPost"
   
+  has_many :posts, :class_name => "BlogPost", :conditions => { :published => true }, :order => "published_at desc"
+  has_many :blog_group_memberships
+  has_many :groups, :through => :blog_group_memberships
+
   validates_presence_of :name
   validates_uniqueness_of :name
-  
+
+  named_scope :editable_by, lambda { |user|
+    if user.able_to?(:administrate)
+      { }
+    else
+      { :include => :groups, :conditions => ["groups.id IN (?)", user.group_ids.join(",")] }
+    end
+  }
+
   def self.default_template
-    template_file = ActionController::Base.view_paths.map do |vp| 
+    template_file = ActionController::Base.view_paths.map do |vp|
       path = vp.to_s.first == "/" ? vp.to_s : File.join(Rails.root, vp.to_s)
       File.join(path, "cms/blogs/render.html.erb")
     end.detect{|f| File.exists? f }
     template_file ? open(template_file){|f| f.read } : ""
   end
-  
+
+  def self.posts_finder(finder, options)
+    if options[:tags]
+      finder = finder.tagged_with(options[:tags])
+    end
+    if options[:exclude_tags]
+      finder = finder.not_tagged_with(options[:exclude_tags])
+    end
+    if options[:category] || options[:category_id]
+      category_type = CategoryType.named("Blog Post").first
+      category = category_type.categories.named(options[:category]).first if options[:category]
+      category = category_type.categories. find(options[:category_id])    if options[:category_id]
+      finder = finder.in_category(category)
+    end
+    finder
+  end
+
   def render
     @blog = self
     finder = @blog.posts.published
-    if params[:tag]
-      finder = finder.tagged_with(params[:tag])
+    finder = Blog.posts_finder(finder, params)
+
+    if params[:year] && params[:month] && params[:day]
+      @date = Date.new(params[:year].to_i, params[:month].to_i, params[:day].to_i)
+      finder = posts.published_between(@date, @date + 1.day)
+    elsif params[:year] && params[:month]
+      @date = Date.new(params[:year].to_i, params[:month].to_i)
+      finder = posts.published_between(@date, @date + 1.month)
+    elsif params[:year]
+      @date = Date.new(params[:year].to_i)
+      finder = posts.published_between(@date, @date + 1.year)
     end
+
+    @blog_posts = finder.all(:limit => 25, :order => "published_at desc")
+    raise ActiveRecord::RecordNotFound.new("No posts found") if @blog_posts.empty?
+
     if params[:category]
-      @category_type = CategoryType.named("Blog Post").first
-      @category = @category_type.categories.named(params[:category]).first
-      finder = finder.in_category(@category)
+      @page_title = "#{params[:category]}"
+    elsif params[:tag]
+      @page_title = "Posts tagged with #{params[:tag]}"
+    elsif params[:year] && params[:month] && params[:day]
+      @page_title = "Posts from #{@date.to_s(:long)}"
+    elsif params[:year] && params[:month]
+      @page_title = "Posts from #{Date::MONTHNAMES[@date.month]} #{@date.year}"
+    elsif params[:year]
+      @page_title = "Posts from #{@date.year}"
     end
-    @blog_posts = finder.all(:limit => 15, :order => "published_at desc") 
   end
-  
+
   def inline_options
     {:inline => self.template}
   end
-  
+
   def self.default_order
     "name"
   end
-  
-end
+
+  def editable_by?(user)
+    user.able_to?(:administrate) || !(group_ids & user.group_ids).empty?
+  end
+
+  def potential_authors
+    groups.map(&:users).flatten.uniq
+  end
+
+  def name_for_path
+    name.to_slug.gsub('-', '_')
+  end
+end

data/app/models/blog_comment.rb

@@ -1,26 +1,32 @@
 class BlogComment < ActiveRecord::Base
   acts_as_content_block :is_searachable => "body"
   belongs_to :post, :class_name => "BlogPost", :counter_cache => "comments_count"
+
+  validates_presence_of :post_id, :author, :body
   
+  def before_create
+    self.published = true unless post.blog.moderate_comments?
+  end
+
   def self.default_order
     "blog_comments.created_at desc"
   end
-  
+
   def self.default_order_for_search
     default_order
-  end  
-  
+  end
+
   def self.columns_for_index
-    [ {:label => "Comment", :method => :name, :order => "blog_comments.body" },
+    [ {:label => "Comment",    :method => :name,                 :order => "blog_comments.body" },
       {:label => "Created At", :method => :formatted_created_at, :order => "blog_comments.created_at"} ]
-  end  
-  
+  end
+
   def name
     body ? body[0..50] : ""
   end
-  
+
   def formatted_created_at
     created_at.to_s(:date)
   end
-  
-end
+
+end

data/app/models/blog_group_membership.rb

@@ -0,0 +1,4 @@
+class BlogGroupMembership < ActiveRecord::Base
+  belongs_to :blog
+  belongs_to :group
+end

data/app/models/blog_observer.rb

@@ -0,0 +1,135 @@
+class BlogObserver < ActiveRecord::Observer
+  
+  def after_create(blog)
+    @blog = blog
+    create_section_pages_and_routes
+  end
+  
+  def before_update(blog)
+    update_section_pages_and_route(blog)
+  end
+  
+  def after_update(blog)
+    blog.publish
+  end
+  
+  private
+  # A section, two pages, 6 routes and a portlet are created alongside every blog.
+  # This structure provides sensible defaults so users can pretty much start adding
+  # posts right after creating a blog without having to worry about where to put
+  # their blog and portlets.
+  def create_section_pages_and_routes
+    create_blog_section
+    create_blog_block_page
+    create_post_portlet_page
+    reload_routes
+  end
+
+  # Every blog is created within a section with the same name.
+  # For example, if you create a blog named 'MyBlog', a section 'MyBlog' will be
+  # created. This section will hold two pages: one for the blog ContentBlock that
+  # will render the list of posts and one for the BlogPost portlet (ie the individual
+  # post view)  
+  def create_blog_section
+    @section = Section.find_by_name(@blog.name) || (
+      @section = Section.create!(
+        :name => @blog.name,
+        :path => "/#{@blog.name_for_path}",
+        :parent_id => 1
+      )
+      @section.groups << Group.find_by_code("cms-admin")
+      @section.groups << Group.find_by_code("guest")
+      @section.groups << Group.find_by_code("content-editor")
+      @section.save!
+      @section
+    )
+  end
+
+  # Following with the above example, the first page that is created is named 'MyBlog' and
+  # holds the Blog ContentBlock directly, not a portlet. Together with the 5 created routes,
+  # this page and its  ContentBlock handle different post listings (all posts, posts in year, 
+  # month or day and posts by tag or category).
+  def create_blog_block_page
+    page = Page.find_by_name(@blog.name) || Page.create!(
+      :name => @blog.name,
+      :path => "/#{@blog.name_for_path}",
+      :section => @section,
+      :template_file_name => "default.html.erb",
+      :hidden => true
+    )
+    page.create_connector(@blog, 'main')
+
+    create_route(page, "#{@blog.name}: Posts In Day",      "/#{@blog.name_for_path}/:year/:month/:day")
+    create_route(page, "#{@blog.name}: Posts In Month",    "/#{@blog.name_for_path}/:year/:month")
+    create_route(page, "#{@blog.name}: Posts In Year",     "/#{@blog.name_for_path}/:year")
+    create_route(page, "#{@blog.name}: Posts With Tag",    "/#{@blog.name_for_path}/tag/:tag")
+    create_route(page, "#{@blog.name}: Posts In Category", "/#{@blog.name_for_path}/category/:category")
+  end
+
+  # The second page that is created holds the BlogPostPortlet and displays the individual
+  # post view, along with it's comments.
+  def create_post_portlet_page
+    page = Page.find_by_name(portlet_name = "#{@blog.name}: Post") || Page.create!(
+      :name => portlet_name,
+      :path => "/#{@blog.name_for_path}/post",
+      :section => @section,
+      :template_file_name => "default.html.erb",
+      :hidden => true)
+    page.publish
+    create_route(page, portlet_name, "/#{@blog.name_for_path}/:year/:month/:day/:slug")
+    create_portlet(page, portlet_name, BlogPostPortlet)
+  end
+
+  # When the name of a Blog block changes, we need to change the Post page route.
+  # We also change the *names* of the section and pages that hold the blog block and 
+  # post portlet because presumably, by changing the name of the blog, the intention 
+  # was to reflect this name change in breadcrumbs and menus. 
+  # 
+  # Note that no other routes or paths are updated. This is intentional to be consistent
+  # with how BrowserCMS behaves when a Section or Page names change: paths are not
+  # updated automatically.
+  def update_section_pages_and_route(blog)
+    if blog.name_changed?
+      old_blog_name = blog.name_was
+
+      Section.find_by_name(old_blog_name).update_attribute(:name, blog.name)
+      PageRoute.find_by_name("#{old_blog_name}: Post").update_attribute(:name, "#{blog.name}: Post")
+
+      page = Page.find_by_name("#{old_blog_name}: Post")
+      page.update_attribute(:name, "#{blog.name}: Post")
+      page.publish
+
+      page = Page.find_by_name(old_blog_name)
+      page.update_attribute(:name, blog.name)
+      page.publish
+    end
+  end 
+
+  def reload_routes
+     ActionController::Routing::Routes.load!
+  end
+
+  def create_route(page, name, pattern)
+    route = page.page_routes.build(:name => name, :pattern => pattern, :code => "")
+    route.add_condition(:method, "get")
+    route.add_requirement(:year,  '\d{4,}') if pattern.include?(":year")
+    route.add_requirement(:month, '\d{2,}') if pattern.include?(":month")
+    route.add_requirement(:day,   '\d{2,}') if pattern.include?(":day")
+    route.send(:create_without_callbacks)
+  end
+
+  def create_portlet(page, name, portlet_class)
+    portlet_class.create!(
+      :name => "#{name} Portlet",
+      :blog_id => @blog.id,
+      :template => portlet_class.default_template,
+      :connect_to_page_id => page.id,
+      :connect_to_container => "main",
+      :publish_on_save => true)
+  end
+end
+
+
+
+
+