bf4-browsercms 3.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

@@ -0,0 +1,57 @@
+# BrowserCMS: Humane Content Management for Rails
+
+BrowserCMS is a general purpose, open source Web Content Management System (CMS), written in Ruby on Rails. It is designed to support three distinct groups of people:
+
+1. Non-technical web editors who want a humane system to manage their site, without needing to understand what HTML or even Rails is.
+2. Designers who want to create large and elegantly designed websites with no artificial constraints by the CMS.
+3. Developers who want to drop a CMS into their Rails projects, or create CMS driven websites for their clients.
+
+## Features
+BrowserCMS is intended to offer features comparable to commercial CMS products, which can support larger teams of editors. This means having a robust set of features as part of its core, as well as the capability to customize it via modules. 
+
+Here's a quick overview of some of the more notable features:
+
+* It's just Rails: Each CMS project is a rails project that depends on the BrowserCMS gem. Developers can add new controllers, views, etc; just like any rails project.
+* Direct in context editing: Users can browse their site to locate content and change it right on the page itself.
+* Design friendly Templates: Pages aren't just a template and giant single chunk of HTML. Templates can be built to have multiple editable areas, to allow for rich designs that are still easy to manage by non-technical users.
+* Sitemap: An explorer/finder style view of sections and pages in a site allowing users to add and organize pages.
+* Content Library: Provides a standardized 'CRUD' interface to allow users to manage both core and custom content types.
+* Content API: A set of behaviors added to ActiveRecord which allow for versioning, auditing, tagging and other content services provided by the CMS.
+* Section Based Security: Admins can control which users can access specific sections (public users), as well as who can edit which pages (cms users).
+* Workflow: Supports larger website teams where some users can contribute, but not publish. Users can assign work to other publishers to review.
+* Page Caching: Full page caching allows the web server (Apache) to serve HTML statically when they don't change.
+
+## Browser Compatibility
+BrowserCMS can create websites that can work in any browser, depending on how developers implement their design as HTML templates. However, the administrator interface is limited to a select # of browsers, with Firefox being the most stable. Supported browsers include:
+
+1. FireFox 3+ (Mac, Windows, Linux) - This is currently the best choice for administering the CMS.
+2. Safari 3.2+ (Mac, Windows) - Works, with some minor layout problems.
+3. Internet Explorer 7+ (Windows) - Mostly functional, though there are a number of layout issues in the admin.
+
+The next releases will be aimed at tightning up the admin for both Safari and IE7+. We will not be supporting the admin UI for IE6, or other browsers not explicitly listed above.
+
+## Getting Started
+Before you can use BrowserCMS, you will need to install the gem. See the Getting Started guide at http://browsercms.org/doc/guides/html/getting_started.html, or packaged with this source code (under doc/guides/html/getting_started.html)
+
+## License
+BrowserCMS is released under a LGPL license, and is copyright 1998-2009 BrowserMedia. The complete copyright can be found in COPYRIGHT.txt, and copy of the license can be found in LICENSE.txt.
+
+
+## Documentation
+The user documentation and guides for this version of the application can be found at:
+
+1. http://browsercms.org/doc/guides/html/index.html - User guides and manuals that cover the features and general functionality of the project. (Found locally at doc/guides/html/index.html)
+2. http://browsercms.org/doc/app/index.html - The RDoc API documenation (locally at doc/app/index.html)
+3. http://wiki.github.com/browsermedia/browsercms - The project wiki
+
+## Modifying the source
+If you want to experiment with the source code, the BrowserCMS project can bootstrap itself as a web application. This allows developers who want to contribute to the project to easily alter and test changes. To run the application itself, do the following:
+
+    cd /path/to/browsercms_source_code
+    rake reset
+    script/server
+
+This will drop the 'browsercms_development' database, loads the same sample data from the demo.rb template. By default, the core project is setup to use mysql as the database, but you can change that via the database.yml files.
+
+## Support
+The homepage for the BrowserCMS project is http://browsercms.org. From there you can find links to the discussion groups and our twitter account. If you have questions about the project or want to get involved, the Google group is the best way to do so. If you would like to report a bug, please do so at https://browsermedia.lighthouseapp.com/projects/28481-browsercms-30

data/app/controllers/application_controller.rb

@@ -0,0 +1,14 @@
+# 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
+
+  # See ActionController::RequestForgeryProtection for details
+  # Uncomment the :secret if you're not using the cookie session store
+  #protect_from_forgery # :secret => '41948d307525ce0f10b2e716ff820465'
+  
+  # See ActionController::Base for details 
+  # Uncomment this to filter the contents of submitted sensitive data parameters
+  # from your application log (in this case, all fields with names like "password"). 
+  # filter_parameter_logging :password
+end

data/app/controllers/cms/application_controller.rb

@@ -0,0 +1,69 @@
+class Cms::ApplicationController < ApplicationController
+  include Cms::Authentication::Controller
+  include Cms::ErrorHandling
+  include Cms::DomainSupport
+
+  helper :all # include all helpers, all the time
+
+  helper Cms::ApplicationHelper
+  helper Cms::FormTagHelper
+  include Cms::PathHelper
+  helper Cms::PathHelper
+  include Cms::PageHelper
+  helper Cms::PageHelper
+  helper Cms::MenuHelper
+  
+  protected
+    def escape_javascript(javascript)
+      (javascript || '').gsub('\\','\0\0').gsub('</','<\/').gsub(/\r\n|\n|\r/, "\\n").gsub(/["']/) { |m| "\\#{m}" }
+    end
+  
+    def redirect_to_first(*urls)
+      urls.each do |url|
+        unless url.blank?
+          return redirect_to(url)
+        end
+      end
+    end
+    
+    def current_site
+      @current_site ||= Site.find_by_domain(request.host)
+    end
+     
+    def redirect_to_cms_site
+      if perform_caching && !cms_site?
+        redirect_to(url_with_cms_domain_prefix)
+      end
+    end 
+  
+    def append_to_query_string(url, *params)
+      new_url = url["?"] ? url : "#{url}?"
+      new_url << params.map{|k,v| "#{k.to_s}=#{CGI::escape(v.to_s)}"}.join("&")
+    end
+  
+    def cms_access_required
+      raise Cms::Errors::AccessDenied unless current_user.able_to?(:administrate, :edit_content, :publish_content)
+    end
+  
+    def self.check_permissions(*perms)
+      opts = Hash === perms.last ? perms.pop : {}
+      before_filter(opts) do |controller|
+        raise Cms::Errors::AccessDenied unless controller.send(:current_user).able_to?(*perms)
+      end      
+    end
+  
+    def url_with_cms_domain_prefix
+      if cms_site?
+        request.url
+      elsif request.subdomains.first == "www"
+        request.url.sub(/www\./, "#{cms_domain_prefix}.")
+      else
+        request.url.sub(/:\/\//, "://#{cms_domain_prefix}.")
+      end
+    end
+  
+    def url_without_cms_domain_prefix
+      request.url.sub(/#{cms_domain_prefix}\./,'')
+    end
+  
+end

data/app/controllers/cms/attachments_controller.rb

@@ -0,0 +1,11 @@
+class Cms::AttachmentsController < Cms::BaseController
+  def show
+    @attachment = Attachment.find(params[:id])
+    @attachment = @attachment.as_of_version(params[:version]) if params[:version]
+    send_file(@attachment.full_file_location, 
+      :filename => @attachment.file_name,
+      :type => @attachment.file_type,
+      :disposition => "inline"
+    )     
+  end
+end

data/app/controllers/cms/base_controller.rb

@@ -0,0 +1,13 @@
+class Cms::BaseController < Cms::ApplicationController
+  
+  before_filter :redirect_to_cms_site
+  before_filter :login_required
+  before_filter :cms_access_required
+
+  layout 'cms/application'
+    
+  verify :method => :post, :only => [:create]
+  verify :method => :put, :only => [:update]
+  verify :method => :delete, :only => [:destroy]
+    
+end

data/app/controllers/cms/cache_controller.rb

@@ -0,0 +1,22 @@
+class Cms::CacheController < Cms::BaseController
+  layout 'cms/administration'
+  
+  check_permissions :administrate  
+  before_filter :set_menu_section
+
+  def show
+    
+  end
+  
+  def destroy
+    Cms.flush_cache
+    flash[:notice] = "Page Cache Flushed"
+    redirect_to :action => "show"
+  end
+  
+  private
+    def set_menu_section
+      @menu_section = 'caching'
+    end
+
+end

data/app/controllers/cms/categories_controller.rb

@@ -0,0 +1,5 @@
+class Cms::CategoriesController < Cms::ContentBlockController
+  def show
+    redirect_to cms_categories_url
+  end
+end

data/app/controllers/cms/category_types_controller.rb

@@ -0,0 +1,5 @@
+class Cms::CategoryTypesController < Cms::ContentBlockController
+  def show
+    redirect_to cms_category_types_url
+  end
+end

data/app/controllers/cms/connectors_controller.rb

@@ -0,0 +1,63 @@
+class Cms::ConnectorsController < Cms::BaseController
+  
+  before_filter :set_toolbar_tab
+  before_filter :load_page, :only => [:new, :create]
+  
+  def new    
+    @block_type = ContentType.find_by_key(params[:block_type] || session[:last_block_type] || 'html_block')
+    @container = params[:container]
+    @connector = @page.connectors.build(:container => @container)
+    @blocks = @block_type.model_class.all(:order => "name", :conditions => ["deleted = ?", false])      
+  end
+
+  def create
+    @block_type = ContentType.find_by_key(params[:connectable_type])
+    raise "Unknown block type" unless @block_type
+    @block = @block_type.model_class.find(params[:connectable_id])
+    if @page.create_connector(@block, params[:container])
+      redirect_to @page.path
+    else
+      @blocks = @block_type.model_class.all(:order => "name")      
+      render :action => 'new'
+    end
+  end
+  
+  def destroy
+    @connector = Connector.find(params[:id])
+    @page = @connector.page
+    @connectable = @connector.connectable
+    if @page.remove_connector(@connector)
+      flash[:notice] = "Removed '#{@connectable.name}' from the '#{@connector.container}' container"
+    else
+      flash[:error] = "Failed to remove '#{@connectable.name}' from the '#{@connector.container}' container"
+    end
+    redirect_to @page.path
+  end
+
+  { #Define actions for moving connectors around
+    :up => "up in",
+    :down => "down in",
+    :to_top => "to the top of",
+    :to_bottom => "to the bottom of"    
+  }.each do |move, where|
+    define_method "move_#{move}" do
+      @connector = Connector.find(params[:id])
+      @page = @connector.page
+      @connectable = @connector.connectable
+      if @page.send("move_connector_#{move}", @connector)
+        flash[:notice] = "Moved '#{@connectable.name}' #{where} the '#{@connector.container}' container"
+      else
+        flash[:error] = "Failed to move '#{@connectable.name}' #{where} the '#{@connector.container}' container"
+      end
+      redirect_to @page.path    
+    end
+  end
+
+  private
+    def load_page
+      @page = Page.find(params[:page_id])
+    end
+    def set_toolbar_tab
+      @toolbar_tab = :content_library
+    end
+end

data/app/controllers/cms/content_block_controller.rb

@@ -0,0 +1,285 @@
+# This is not called directly
+# This is the base class for other content blocks
+class Cms::ContentBlockController < Cms::BaseController
+  
+  layout :determine_layout
+  
+  before_filter :set_toolbar_tab
+  
+  helper_method :block_form, :new_block_path, :block_path, :blocks_path, :content_type
+  helper Cms::RenderingHelper
+  # Basic REST Crud Action
+  
+  def index
+    load_blocks
+    render "#{template_directory}/index"
+  end
+  
+  def show
+    load_block_draft
+    render "#{template_directory}/show"
+  end
+  
+  def new
+    build_block
+    set_default_category
+    render "#{template_directory}/new"
+  end
+  
+  def create
+    if create_block
+      after_create_on_success
+    else
+      after_create_on_failure
+    end
+  rescue Exception => @exception
+    raise @exception if @exception.is_a?(Cms::Errors::AccessDenied)
+    after_create_on_error
+  end
+  
+  def edit
+    load_block_draft
+    render "#{template_directory}/edit"
+  end
+  
+  def update
+    if update_block
+      after_update_on_success
+    else
+      after_update_on_failure
+    end
+  rescue ActiveRecord::StaleObjectError => @exception
+    after_update_on_edit_conflict
+  rescue Exception => @exception
+    raise @exception if @exception.is_a?(Cms::Errors::AccessDenied)
+    after_update_on_error
+  end
+  
+  def destroy
+    do_command("deleted") { @block.destroy }
+    redirect_to_first params[:_redirect_to], blocks_path
+  end
+  
+  # Additional CMS Action
+  
+  def publish
+    do_command("published") { @block.publish! }
+    redirect_to_first params[:_redirect_to], block_path
+  end
+  
+  def revert_to
+    do_command("reverted to version #{params[:version]}") do
+      revert_block(params[:version])
+    end
+    redirect_to_first params[:_redirect_to], block_path
+  end
+  
+  def version
+    load_block
+    if params[:version]
+      @block = @block.as_of_version(params[:version])
+    end
+    render "#{template_directory}/show"
+  end
+  
+  def versions
+    if model_class.versioned?
+      load_block
+      render "#{template_directory}/versions"
+    else
+      render :text => "Not Implemented", :status => :not_implemented
+    end    
+  end
+    
+  def usages
+    load_block_draft
+    @pages = @block.connected_pages.all(:order => 'name')
+    render "#{template_directory}/usages"
+  end
+  
+  protected
+    # methods that are used to detemine what content block type we are dealing with
+
+    def content_type_name
+      self.class.name.sub(/Controller/,'').demodulize.singularize
+    end
+
+    def content_type
+      @content_type ||= ContentType.find_by_key(content_type_name)
+    end  
+
+    def model_class
+      content_type.model_class
+    end
+  
+    def model_name
+      model_class.name.underscore.to_sym
+    end
+  
+    # methods for loading one or a collection of blocks
+  
+    def load_blocks
+      options = {}
+      if params[:section_id] && params[:section_id] != 'all'
+        options[:include] = { :attachment => { :section_node => :section }} 
+        options[:conditions] = ["sections.id = ?", params[:section_id]]
+      end
+      options[:page] = params[:page]    
+      options[:order] = model_class.default_order if model_class.respond_to?(:default_order)
+      options[:order] = params[:order] unless params[:order].blank?
+      scope = model_class.respond_to?(:list) ? model_class.list : model_class
+      @blocks = scope.searchable? ? scope.search(params[:search]).paginate(options) : scope.paginate(options)
+      check_permissions
+    end
+  
+    def load_block
+      @block = model_class.find(params[:id])
+      check_permissions
+    end
+  
+    def load_block_draft
+      @block = model_class.find(params[:id])
+      @block = @block.as_of_draft_version if model_class.versioned?
+      check_permissions
+    end
+  
+    # path related methods - available in the view as helpers
+  
+    def new_block_path(options={})
+      cms_new_url_for(@block, options)
+    end
+  
+    def block_path(action=nil)
+      path = [:cms, @block]
+      action ? path.unshift(action) : path
+    end
+  
+    def blocks_path(options={})
+      cms_index_url_for(@block, options)
+    end
+
+    # This is the partial that will be used in the form
+    def block_form
+      @content_type.form
+    end
+  
+    # new related methods
+  
+    def build_block
+      @block = model_class.new(params[model_name])
+      check_permissions
+    end
+
+    def set_default_category
+      if @last_block = model_class.last
+        @block.category = @last_block.category if @block.respond_to?(:category=)
+      end      
+    end
+    
+    # create related methods
+    
+    def create_block
+      build_block
+      @block.save
+    end
+
+    def after_create_on_success
+      block = @block.class.versioned? ? @block.draft : @block
+      flash[:notice] = "#{content_type.display_name} '#{block.name}' was created"
+      if @block.class.connectable? && @block.connected_page
+        redirect_to @block.connected_page.path
+      else
+        redirect_to_first params[:_redirect_to], block_path
+      end
+    end
+
+    def after_create_on_failure
+      render "#{template_directory}/new"
+    end
+
+    def after_create_on_error
+      logger.error "#{@exception.message}\n#{@exception.backtrace.join('\n')}"      
+      after_create_on_failure
+    end
+
+    # update related methods
+    def update_block
+      load_block
+      @block.update_attributes(params[model_name])
+    end
+
+    def after_update_on_success
+      flash[:notice] = "#{content_type_name.titleize} '#{@block.name}' was updated"
+      redirect_to_first params[:_redirect_to], block_path
+    end
+
+    def after_update_on_failure
+      render "#{template_directory}/edit"
+    end
+
+    def after_update_on_edit_conflict
+      @other_version = @block.class.find(@block.id)
+      after_update_on_failure
+    end
+
+    def after_update_on_error
+      logger.error "#{@exception.message}\n#{@exception.backtrace.join('\n')}"
+      after_update_on_failure
+    end
+
+    # methods for other actions
+
+    # A "command" is when you want to perform an action on a content block
+    # You pass a ruby block to this method, this calls it
+    # and then sets a flash message based on success or failure
+    def do_command(result)
+      load_block
+      if yield
+        flash[:notice] = "#{content_type_name.titleize} '#{@block.name}' was #{result}"
+      else
+        flash[:error] = "#{content_type_name.titleize} '#{@block.name}' could not be #{result}"
+      end
+    end
+
+    def revert_block(to_version)
+      begin
+        @block.revert_to(to_version)
+      rescue Exception => @exception
+        logger.warn "Could not revert #{@block.inspect} to version #{to_version}"
+        logger.warn "#{@exception.message}\n:#{@exception.backtrace.join("\n")}"
+        false
+      end
+    end
+    
+    # Use a "whitelist" approach to access to avoid mistakes
+    # By default everyone can create new block and view them and their properties,
+    # but blocks can only be modified based on the permissions of the pages they
+    # are connected to.
+    def check_permissions
+      case action_name
+        when "index", "show", "new", "create", "version", "versions", "usages"
+          # Allow
+        when "edit", "update"
+          raise Cms::Errors::AccessDenied unless current_user.able_to_edit?(@block)
+        when "destroy", "publish", "revert_to"
+          raise Cms::Errors::AccessDenied unless current_user.able_to_publish?(@block)
+        else
+          raise Cms::Errors::AccessDenied
+      end
+    end
+
+    # methods to setup the view
+
+    def set_toolbar_tab
+      @toolbar_tab = :content_library
+    end
+
+    def determine_layout
+      'cms/content_library'
+    end
+
+    def template_directory
+      "cms/blocks"
+    end
+
+end