Chris@909: # Redmine - project management software
Chris@909: # Copyright (C) 2006-2011  Jean-Philippe Lang
Chris@909: #
Chris@909: # This program is free software; you can redistribute it and/or
Chris@909: # modify it under the terms of the GNU General Public License
Chris@909: # as published by the Free Software Foundation; either version 2
Chris@909: # of the License, or (at your option) any later version.
Chris@909: #
Chris@909: # This program is distributed in the hope that it will be useful,
Chris@909: # but WITHOUT ANY WARRANTY; without even the implied warranty of
Chris@909: # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
Chris@909: # GNU General Public License for more details.
Chris@909: #
Chris@909: # You should have received a copy of the GNU General Public License
Chris@909: # along with this program; if not, write to the Free Software
Chris@909: # Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
Chris@909: 
Chris@909: module Redmine
Chris@909:   module WikiFormatting
Chris@909:     class StaleSectionError < Exception; end
Chris@909: 
Chris@909:     @@formatters = {}
Chris@909: 
Chris@909:     class << self
Chris@909:       def map
Chris@909:         yield self
Chris@909:       end
Chris@909: 
Chris@909:       def register(name, formatter, helper)
Chris@909:         raise ArgumentError, "format name '#{name}' is already taken" if @@formatters[name.to_s]
Chris@909:         @@formatters[name.to_s] = {:formatter => formatter, :helper => helper}
Chris@909:       end
Chris@909: 
Chris@909:       def formatter
Chris@909:         formatter_for(Setting.text_formatting)
Chris@909:       end
Chris@909: 
Chris@909:       def formatter_for(name)
Chris@909:         entry = @@formatters[name.to_s]
Chris@909:         (entry && entry[:formatter]) || Redmine::WikiFormatting::NullFormatter::Formatter
Chris@909:       end
Chris@909: 
Chris@909:       def helper_for(name)
Chris@909:         entry = @@formatters[name.to_s]
Chris@909:         (entry && entry[:helper]) || Redmine::WikiFormatting::NullFormatter::Helper
Chris@909:       end
Chris@909: 
Chris@909:       def format_names
Chris@909:         @@formatters.keys.map
Chris@909:       end
Chris@909: 
Chris@909:       def to_html(format, text, options = {})
Chris@909:         text = if Setting.cache_formatted_text? && text.size > 2.kilobyte && cache_store && cache_key = cache_key_for(format, options[:object], options[:attribute])
Chris@909:           # Text retrieved from the cache store may be frozen
Chris@909:           # We need to dup it so we can do in-place substitutions with gsub!
Chris@909:           cache_store.fetch cache_key do
Chris@909:             formatter_for(format).new(text).to_html
Chris@909:           end.dup
Chris@909:         else
Chris@909:           formatter_for(format).new(text).to_html
Chris@909:         end
Chris@909:         text
Chris@909:       end
Chris@909: 
Chris@909:       # Returns true if the text formatter supports single section edit
Chris@909:       def supports_section_edit?
Chris@909:         (formatter.instance_methods & ['update_section', :update_section]).any?
Chris@909:       end
Chris@909: 
Chris@909:       # Returns a cache key for the given text +format+, +object+ and +attribute+ or nil if no caching should be done
Chris@909:       def cache_key_for(format, object, attribute)
Chris@909:         if object && attribute && !object.new_record? && object.respond_to?(:updated_on) && !format.blank?
Chris@909:           "formatted_text/#{format}/#{object.class.model_name.cache_key}/#{object.id}-#{attribute}-#{object.updated_on.to_s(:number)}"
Chris@909:         end
Chris@909:       end
Chris@909: 
Chris@909:       # Returns the cache store used to cache HTML output
Chris@909:       def cache_store
Chris@909:         ActionController::Base.cache_store
Chris@909:       end
Chris@909:     end
Chris@909: 
Chris@909:     # Default formatter module
Chris@909:     module NullFormatter
Chris@909:       class Formatter
Chris@909:         include ActionView::Helpers::TagHelper
Chris@909:         include ActionView::Helpers::TextHelper
Chris@909:         include ActionView::Helpers::UrlHelper
Chris@909: 
Chris@909:         def initialize(text)
Chris@909:           @text = text
Chris@909:         end
Chris@909: 
Chris@909:         def to_html(*args)
Chris@909:           simple_format(auto_link(CGI::escapeHTML(@text)))
Chris@909:         end
Chris@909:       end
Chris@909: 
Chris@909:       module Helper
Chris@909:         def wikitoolbar_for(field_id)
Chris@909:         end
Chris@909: 
Chris@909:         def heads_for_wiki_formatter
Chris@909:         end
Chris@909: 
Chris@909:         def initial_page_content(page)
Chris@909:           page.pretty_title.to_s
Chris@909:         end
Chris@909:       end
Chris@909:     end
Chris@909:   end
Chris@909: end