comatose 2.0.1

data/lib/comatose_admin_controller.rb

@@ -0,0 +1,349 @@
+# The controller for serving cms content...
+class ComatoseAdminController < ActionController::Base
+  unloadable
+    
+  define_option :original_template_root, nil
+  define_option :plugin_layout_path, File.join( '..', '..', '..', 'vendor', 'plugins', 'comatose', 'views', 'layouts' )
+
+  before_filter :handle_authorization
+  before_filter :set_content_type
+  layout 'comatose_admin'
+
+  # Shows the page tree
+  def index
+    @root_pages = [fetch_root_page].flatten
+  end
+
+  # Edit a specfic page (posts back)
+  def edit
+    # Clear the page cache for this page... ?
+    @page = ComatosePage.find params[:id]
+    @root_pages = [fetch_root_page].flatten
+    if request.post?
+      @page.update_attributes(params[:page])
+      @page.updated_on = Time.now
+      @page.author = fetch_author_name
+      if @page.save
+        expire_cms_page @page
+        expire_cms_fragment @page
+        flash[:notice] = "Saved changes to '#{@page.title}'"
+        redirect_to :controller=>self.controller_name, :action=>'index'
+      end
+    end
+  end
+
+  # Create a new page (posts back)
+  def new
+    @root_pages = [fetch_root_page].flatten
+    if request.post?
+      @page = ComatosePage.new params[:page]
+      @page.author = fetch_author_name
+      if @page.save
+        flash[:notice] = "Created page '#{@page.title}'"
+        redirect_to :controller=>self.controller_name, :action=>'index'
+      end
+    else
+      @page = ComatosePage.new :title=>'New Page', :parent_id=>(params[:parent] || nil)
+    end
+  end
+
+  # Saves position of child pages
+  def reorder
+    # If it's AJAX, do our thing and move on...
+    if request.xhr?
+      params["page_list_#{params[:id]}"].each_with_index { |id,idx| ComatosePage.update(id, :position => idx) }
+      expire_cms_page ComatosePage.find(params[:id])
+      render :text=>'Updated sort order', :layout=>false
+    else
+      @page = ComatosePage.find params[:id]
+      if params.has_key? :cmd
+        @target = ComatosePage.find params[:page]
+        case params[:cmd]
+          when 'up' then @target.move_higher
+          when 'down' then @target.move_lower
+        end
+        redirect_to :action=>'reorder', :id=>@page
+      end
+    end
+  end
+
+  # Allows comparing between two versions of a page's content
+  def versions
+    @page = ComatosePage.find params[:id]
+    @version_num = (params[:version] || @page.versions.length).to_i
+    @version = @page.find_version(@version_num)
+  end
+
+  # Reverts a page to a specific version...
+  def set_version
+    if request.post?
+      @page = ComatosePage.find params[:id]
+      @version_num = params[:version]
+      @page.revert_to!(@version_num)
+    end
+    redirect_to :controller=>self.controller_name, :action=>'index'
+  end
+
+  # Deletes the specified page
+  def delete
+    @page = ComatosePage.find params[:id]
+    if request.post?
+      expire_cms_pages_from_bottom @page
+      expire_cms_fragments_from_bottom @page
+      @page.destroy
+      flash[:notice] = "Deleted page '#{@page.title}'"
+      redirect_to :controller=>self.controller_name, :action=>'index'
+    end
+  end
+
+  # Returns a preview of the page content...
+  def preview
+    begin
+      page = ComatosePage.new(params[:page])
+      page.author = fetch_author_name
+      if params.has_key? :version
+        content = page.to_html( {'params'=>params.stringify_keys, 'version'=>params[:version]} )
+      else
+        content = page.to_html( {'params'=>params.stringify_keys} )
+      end
+    rescue SyntaxError
+      content = "<p>There was an error generating the preview.</p><p><pre>#{$!.to_s.gsub(/\</, '&lt;')}</pre></p>"
+    rescue
+      content = "<p>There was an error generating the preview.</p><p><pre>#{$!.to_s.gsub(/\</, '&lt;')}</pre></p>"
+    end
+    render :text=>content, :layout => false
+  end
+
+  # Expires the entire page cache
+  def expire_page_cache
+    expire_cms_pages_from_bottom( fetch_root_page )
+    expire_cms_fragments_from_bottom( fetch_root_page )
+    flash[:notice] = "Page cache has been flushed"
+    redirect_to :controller=>self.controller_name, :action=>'index'
+  end
+
+  # Walks the page tree and generates HTML files in your /public
+  # folder... It will skip pages that have a 'nocache' keyword
+  # TODO: Make page cache generation work when in :plugin mode
+  def generate_page_cache
+    if runtime_mode == :plugin
+      @errors = ["Page cache cannot be generated in plugin mode"]
+    else
+      @errors = generate_all_pages_html(params)
+    end
+    if @errors.length == 0 
+      flash[:notice] = "Pages Cached Successfully"
+    else
+      flash[:notice] = "Pages Cache Error(s): #{@errors.join(', ')}"
+      flash[:cache_errors] = @errors 
+    end
+    redirect_to :controller=>self.controller_name, :action=>'index'
+  end
+
+
+protected
+
+  def handle_authorization
+    if Comatose.config.admin_authorization.is_a? Proc
+      instance_eval &Comatose.config.admin_authorization
+    elsif Comatose.config.admin_authorization.is_a? Symbol
+      send(Comatose.config.admin_authorization)
+    elsif defined? authorize
+      authorize
+    else
+      true
+    end
+  end
+
+  def fetch_author_name
+    if Comatose.config.admin_get_author.is_a? Proc
+      instance_eval &Comatose.config.admin_get_author
+    elsif Comatose.config.admin_get_author.is_a? Symbol
+      send(Comatose.config.admin_get_author)
+    elsif defined? get_author
+      get_author
+    end
+  end
+
+  # Can be overridden -- return your root comtase page
+  def fetch_root_page
+    if Comatose.config.admin_get_root_page.is_a? Proc
+      instance_eval &Comatose.config.admin_get_root_page
+    elsif Comatose.config.admin_get_root_page.is_a? Symbol
+      send(Comatose.config.admin_get_root_page)
+    elsif defined? get_root_page
+      get_root_page
+    end      
+  end
+
+  # Sets the HTTP content-type header based on what's configured 
+  # in Comatose.config.content_type
+  def set_content_type
+    response.headers["Content-Type"] = "text/html; charset=#{Comatose.config.content_type}" unless Comatose.config.content_type.nil?
+  end
+
+  # Calls generate_page_html for each mount point..
+  def generate_all_pages_html(params={})
+    @errors = []
+    @been_cached = []
+    Comatose.mount_points.each do |root_info|
+      ComatosePage.active_mount_info = root_info
+      generate_page_html(ComatosePage.find_by_path( root_info[:index] ), root_info, params)
+    end
+    @errors
+  end
+
+  # Accepts a Comatose Page and a root_info object to generate
+  # the page as a static HTML page -- using the layout that was
+  # defined on the mount point
+  def generate_page_html(page, root_info, params={})
+    @been_cached ||= []
+    unless page.has_keyword? :nocache or @been_cached.include? page.id
+      uri = page.uri
+      uri = "#{uri}/index".split('/').flatten.join('/') if page.full_path == root_info[:index]
+      @page = Comatose::PageWrapper.new(page)
+      begin
+        page_layout = get_page_layout(root_info)
+        #puts "mode = #{runtime_mode}, layout = #{page_layout}, template_root = #{template_root}, original_template_root = #{original_template_root}"
+        html = render_to_string( :text=>page.to_html({'params'=>params.stringify_keys}), :layout=>page_layout )
+        cache_page( html, uri )
+      rescue
+        logger.error "Comatose CMS Page Cache Exception: #{$!}"
+        @errors << "(#{page}/#{page.slug}) - #{$!}"
+      end
+      @been_cached << page.id
+      # recurse...
+      page.children.each do |child|
+        generate_page_html(child, root_info)
+      end
+    end
+  end
+  
+  # Calls the class methods of the same name...
+  def expire_cms_page(page)
+    self.class.expire_cms_page(page)
+  end
+  def expire_cms_pages_from_bottom(page)
+    self.class.expire_cms_pages_from_bottom(page)
+  end
+  
+
+  # expire the page from the fragment cache
+  def expire_cms_fragment(page)
+    key = page.full_path.gsub(/\//, '+')
+    expire_fragment(key)
+  end
+
+  # expire pages starting at a specific node
+  def expire_cms_fragments_from_bottom(page)
+    pages = page.is_a?(Array) ? page : [page] 
+    pages.each do |page|
+      page.children.each {|c| expire_cms_fragments_from_bottom( c ) } if !page.children.empty?
+      expire_cms_fragment( page )
+    end
+  end
+
+  # Class Methods...
+  class << self
+
+    # Walks all the way down, and back up the tree -- the allows the expire_cms_page
+    # to delete empty directories better
+    def expire_cms_pages_from_bottom(page)
+      pages = page.is_a?(Array) ? page : [page] 
+      pages.each do |page|
+        page.children.each {|c| expire_cms_pages_from_bottom( c ) } if !page.children.empty?
+        expire_cms_page( page )
+      end
+    end
+
+    # Expire the page from all the mount points...
+    def expire_cms_page(page)
+      Comatose.mount_points.each do |path_info|
+        ComatosePage.active_mount_info = path_info
+        expire_page(page.uri)
+        # If the page is the index page for the root, expire it too
+        if path_info[:root] == page.uri
+          expire_page("#{path_info[:root]}/index")
+        end
+        begin # I'm not sure this matters too much -- but it keeps things clean
+          dir_path = File.join(RAILS_ROOT, 'public', page.uri[1..-1])
+          Dir.delete( dir_path ) if FileTest.directory?( dir_path ) and !page.parent.nil?
+        rescue
+          # It probably isn't empty -- just as well we leave it be
+          #STDERR.puts " - Couldn't delete dir #{dir_path} -> #{$!}"
+        end 
+      end
+    end
+
+    # Returns a path to plugin layout, if it's unspecified, otherwise
+    # a path to an application layout...
+    def get_page_layout(params)
+      if params[:layout] == 'comatose_content'
+        File.join(plugin_layout_path, params[:layout])
+      else
+        params[:layout]
+      end
+    end
+  
+    def configure_template_root
+      if self.runtime_mode == :unknown
+        if FileTest.exist? File.join(RAILS_ROOT, 'public', 'javascripts', 'comatose_admin.js')
+          self.runtime_mode = :application
+        else
+          self.runtime_mode = :plugin
+        end
+      end
+    end
+
+    def runtime_mode
+      @@runtime_mode ||= :unknown
+    end
+  
+    def runtime_mode=(mode)
+      admin_view_path = File.expand_path(File.join( File.dirname(__FILE__), '..', 'views'))
+      if self.respond_to?(:template_root)
+        case mode
+        when :plugin
+          self.original_template_root = self.template_root
+          self.template_root = admin_view_path
+        when :application
+          self.template_root = self.original_template_root if self.original_template_root
+        end
+      else
+        ActionController::Base.append_view_path(admin_view_path) unless ActionController::Base.view_paths.include?(admin_view_path)
+      end
+      @@runtime_mode = mode
+    end
+
+  end
+  
+  # Check to see if we are in 'embedded' mode, or are being 'customized'
+  #  embedded   = runtime_mode of :plugin
+  #  customized = runtime_mode of :application
+  configure_template_root
+  
+  #
+  # Include any modules...
+  Comatose.config.admin_includes.each do |mod|
+    if mod.is_a? String
+      include mod.constantize
+    elsif mod.is_a? Symbol
+      include mod.to_s.classify.constantize
+    else
+      include mod
+    end
+  end
+
+  # Include any helpers...
+  Comatose.config.admin_helpers.each do |mod|
+    if mod.is_a? String
+      helper mod.constantize
+    elsif mod.is_a? Symbol
+      helper mod.to_s.classify.constantize
+    else
+      helper mod
+    end
+  end
+
+
+end

data/lib/comatose_admin_helper.rb

@@ -0,0 +1,37 @@
+module ComatoseAdminHelper
+
+  #  Checks the hidden_meta_fields class variable for a specified field name...
+  def show_field?(key)
+    !Comatose.config.hidden_meta_fields.include? key
+  end
+
+  # Used in the Page Form to build an indented drop-down list of pages
+  def tree_select_box(nodes, selected= nil, hide= nil, label="Parent", add_initial=false)
+    level = 0
+    select_box = add_initial ? "<option value=0>No #{label}</option>\n" : ""
+    selected = nodes[0].id if selected.nil? and not add_initial
+    nodes.each {|node| select_box += add_select_tree_node(node, selected, level, hide) }
+    select_box += ''
+  end
+  # Called by tree_select_box
+  def add_select_tree_node(node, selected, level, hide)
+    padding = "&nbsp;" * level * 4
+    padding += '&raquo; ' unless level==0
+    hide_values = Array.new
+    hide_values << hide if hide
+    if node.id == selected
+      select_box = %Q|<option value="#{node.id}" selected="true">#{padding}#{node.title}</option>\n|
+    else
+      if hide_values.include?(node.id)
+        select_box = ''
+      else
+        select_box = %Q|<option value="#{node.id}">#{padding}#{node.title}</option>\n|
+      end
+    end
+    node.children.each do |child|
+      select_box += add_select_tree_node(child, selected, level + 1, hide) unless hide_values.include?(node.id)
+    end
+    select_box
+  end
+  
+end

data/lib/comatose_controller.rb

@@ -0,0 +1,141 @@
+# The controller for serving cms content...
+class ComatoseController < ActionController::Base 
+  
+  before_filter :handle_authorization, :set_content_type
+  after_filter :cache_cms_page
+    
+  # Render a specific page
+  def show
+    page_name, page_ext = get_page_path
+    page = ComatosePage.find_by_path( page_name )
+    status = nil
+    if page.nil?
+      page = ComatosePage.find_by_path( '404' )
+      status = 404
+    end
+    # if it's still nil, well, send a 404 status
+    if page.nil?
+      render :nothing=>true, :status=>status
+      #raise ActiveRecord::RecordNotFound.new("Comatose page not found ")
+    else
+      # Make the page access 'safe' 
+      @page = Comatose::PageWrapper.new(page)
+      # For accurate uri creation, tell the page class which is the active mount point...
+      ComatosePage.active_mount_info = get_active_mount_point(params[:index])
+      render :text=>page.to_html({'params'=>params.stringify_keys}), :layout=>get_page_layout, :status=>status
+    end
+  end
+
+protected
+
+  def handle_authorization
+    if Comatose.config.authorization.is_a? Proc
+      instance_eval &Comatose.config.authorization
+    elsif Comatose.config.authorization.is_a? Symbol
+      send(Comatose.config.authorization)
+    elsif defined? authorize
+      authorize
+    else
+      true
+    end
+  end
+
+  def allow_page_cache?
+    # You should have access to the @page being rendered
+    true
+  end
+
+  # For use in the #show method... determines the current mount point
+  def get_active_mount_point( index )
+    Comatose.mount_points.each do |path_info|
+      if path_info[:index] == index
+        return path_info
+      end
+    end
+    {:root=>"", :index=>index}
+  end
+
+  # For use in the #show method... determines the current page path
+  def get_page_path
+
+    #in rails 2.0, params[:page] comes back as just an Array, so to_s doesn't do join('/')
+    if params[:page].is_a? Array
+      page_name = params[:page].join("/")
+    #in rails 1.x, params[:page] comes back as ActionController::Routing::PathSegment::Result
+    elsif params[:page].is_a? ActionController::Routing::PathSegment::Result
+      page_name = params[:page].to_s
+    else
+      logger.debug "get_page_path - params[:page] is an unrecognized type, may cause problems: #{params[:page].class}"
+      page_name = params[:page].to_s
+    end
+
+    page_ext = page_name.split('.')[1] unless page_name.empty?
+    # TODO: Automatic support for page RSS feeds... ????
+    if page_name.nil? or page_name.empty?
+      page_name = params[:index]
+      params[:cache_path] = "#{request.request_uri}/index"
+    elsif !params[:index].empty?
+      page_name = "#{params[:index]}/#{page_name}"
+    end
+    return page_name, page_ext
+  end
+
+  # Returns a path to plugin layout, if it's unspecified, otherwise
+  # a path to an application layout...
+  def get_page_layout
+    if params[:layout] == 'comatose_content'
+      File.join(plugin_layout_path, params[:layout])
+    else
+      params[:layout]
+    end
+  end
+
+  # An after_filter implementing page caching if it's enabled, globally, 
+  # and is allowed by #allow_page_cache?
+  def cache_cms_page
+    unless Comatose.config.disable_caching or response.headers['Status'] == '404 Not Found'
+      return unless params[:use_cache].to_s == 'true' and allow_page_cache?
+      path = params[:cache_path] || request.request_uri
+      begin
+        # TODO: Don't cache pages rendering '404' content...
+        self.class.cache_page( response.body, path )
+      rescue
+        logger.error "Comatose CMS Page Cache Exception: #{$!}"
+      end
+    end
+  end
+
+  # An after_filter that sets the HTTP header for Content-Type to
+  # what's defined in Comatose.config.content_type. Defaults to utf-8.
+  def set_content_type
+    response.headers["Content-Type"] = "text/html; charset=#{Comatose.config.content_type}" unless Comatose.config.content_type.nil? or response.headers['Status'] == '404 Not Found'
+  end
+
+  # Path to layouts within the plugin... Assumes the plugin directory name is 'comatose'
+  define_option :plugin_layout_path, File.join( '..', '..', '..', 'vendor', 'plugins', 'comatose', 'views', 'layouts'  )
+
+  # Include any, well, includes...
+  Comatose.config.includes.each do |mod|
+    mod_klass = if mod.is_a? String
+      mod.constantize
+    elsif mod.is_a? Symbol
+      mod.to_s.classify.constantize
+    else
+      mod
+    end
+    include mod_klass
+  end
+  
+  # Include any helpers...
+  Comatose.config.helpers.each do |mod|
+    mod_klass = if mod.is_a? String
+      mod.constantize
+    elsif mod.is_a? Symbol
+      mod.to_s.classify.constantize
+    else
+      mod
+    end
+    helper mod_klass
+  end
+end
+

data/lib/comatose_helper.rb

@@ -0,0 +1,3 @@
+module ComatoseHelper
+  
+end

data/lib/comatose_page.rb

@@ -0,0 +1,141 @@
+# ComatosePage attributes
+#  - parent_id
+#  - title
+#  - full_path
+#  - slug
+#  - keywords
+#  - body
+#  - author
+#  - filter_type
+#  - position
+#  - version
+#  - updated_on
+#  - created_on
+class ComatosePage < ActiveRecord::Base
+  
+  set_table_name 'comatose_pages'
+  
+  # Only versions the content... Not all of the meta data or position
+  acts_as_versioned :table_name=>'comatose_page_versions', :if_changed => [:title, :slug, :keywords, :body]
+  
+  define_option :active_mount_info, {:root=>'', :index=>''}
+
+  acts_as_tree :order => "position, title"
+  acts_as_list :scope => :parent_id
+
+  #before_create :create_full_path
+  before_save :cache_full_path, :create_full_path
+  after_save :update_children_full_path
+
+  # Using before_validation so we can default the slug from the title
+  before_validation do |record|
+    # Create slug from title
+    if record.slug.blank? and !record.title.blank?
+      record.slug = record.title.downcase.lstrip.rstrip.gsub( /[^-a-z0-9~\s\.:;+=_]/, '').gsub(/[\s\.:;=_+]+/, '-').gsub(/[\-]{2,}/, '-').to_s
+    end
+  end
+  
+  # Manually set these, because record_timestamps = false
+  before_create do |record|
+    record.created_on = record.updated_on = Time.now
+  end
+
+  validates_presence_of :title, :on => :save, :message => "must be present"
+  validates_uniqueness_of :slug, :on => :save, :scope=>'parent_id', :message => "is already in use"
+  validates_presence_of :parent_id, :on=>:create, :message=>"must be present"
+
+  # Tests ERB/Liquid content...
+  validates_each :body, :allow_nil=>true, :allow_blank=>true do |record, attr, value|
+    begin
+      body_html = record.to_html
+    rescue SyntaxError
+      record.errors.add :body, "syntax error: #{$!.to_s.gsub('<', '&lt;')}"
+    rescue 
+      record.errors.add :body, "content error: #{$!.to_s.gsub('<', '&lt;')}"
+    end
+  end
+    
+  # Returns a pages URI dynamically, based on the active mount point
+  def uri
+    if full_path == ''
+      active_mount_info[:root]
+    else
+      page_path = (full_path || '').split('/')
+      idx_path = active_mount_info[:index].split('/')
+      uri_root = active_mount_info[:root].split('/')
+      uri_path = ( uri_root + (page_path - idx_path) ).flatten.delete_if {|i| i == "" }
+      ['',uri_path].join('/')
+    end
+  end
+  
+  # Check if a page has a selected keyword... NOT case sensitive. 
+  # So the keyword McCray is the same as mccray
+  def has_keyword?(keyword)
+     @key_list ||= (self.keywords || '').downcase.split(',').map {|k| k.strip }
+     @key_list.include? keyword.to_s.downcase
+   rescue
+     false
+   end
+
+  # Returns the page's content, transformed and filtered...
+  def to_html(options={})
+    #version = options.delete(:version)
+    text = self.body
+    binding = Comatose::ProcessingContext.new(self, options)
+    filter_type = self.filter_type || '[No Filter]'
+    TextFilters.transform(text, binding, filter_type, Comatose.config.default_processor)
+  end
+
+# Static helpers...
+  
+  # Returns a Page with a matching path.
+  def self.find_by_path( path )
+     path = path.split('.')[0] unless path.empty? # Will ignore file extension...
+     path = path[1..-1] if path.starts_with? "/"
+     find( :first, :conditions=>[ 'full_path = ?', path ] )
+  end
+  
+# Overrides...
+
+  # I don't want the AR magic timestamping support for this class...
+  def record_timestamps
+    false
+  end
+  def self.record_timestamps
+    false
+  end
+  
+protected
+
+  # Creates a URI path based on the Page tree
+  def create_full_path
+     if parent_node = self.parent
+        # Build URI Path
+        path = "#{parent_node.full_path}/#{self.slug}"
+        # strip leading space, if there is one...
+        path = path[1..-1] if path.starts_with? "/"
+        self.full_path = path || ""
+     else
+        # I'm the root -- My path is blank
+        self.full_path = ""
+     end
+  end
+  def create_full_path!
+    create_full_path
+    save
+  end
+  
+  # Caches old path (before save) for comparison later
+  def cache_full_path
+    @old_full_path = self.full_path
+  end
+
+  # Updates all this content's child URI paths
+  def update_children_full_path(should_save=true)
+    # OPTIMIZE: Only update all the children if the :slug/:fullpath is different
+    for child in self.children
+      child.create_full_path! unless child.frozen?
+      child.update_children_full_path(should_save)
+    end
+  end
+end