Chris@1494: # Redmine - project management software
Chris@1494: # Copyright (C) 2006-2014 Jean-Philippe Lang
Chris@1494: #
Chris@1494: # This program is free software; you can redistribute it and/or
Chris@1494: # modify it under the terms of the GNU General Public License
Chris@1494: # as published by the Free Software Foundation; either version 2
Chris@1494: # of the License, or (at your option) any later version.
Chris@1494: #
Chris@1494: # This program is distributed in the hope that it will be useful,
Chris@1494: # but WITHOUT ANY WARRANTY; without even the implied warranty of
Chris@1494: # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
Chris@1494: # GNU General Public License for more details.
Chris@1494: #
Chris@1494: # You should have received a copy of the GNU General Public License
Chris@1494: # along with this program; if not, write to the Free Software
Chris@1494: # Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
Chris@1494:
Chris@1494: require 'digest/md5'
Chris@1494:
Chris@1494: module Redmine
Chris@1494: module WikiFormatting
Chris@1494: class StaleSectionError < Exception; end
Chris@1494:
Chris@1494: @@formatters = {}
Chris@1494:
Chris@1494: class << self
Chris@1494: def map
Chris@1494: yield self
Chris@1494: end
Chris@1494:
Chris@1494: def register(name, formatter, helper)
Chris@1494: raise ArgumentError, "format name '#{name}' is already taken" if @@formatters[name.to_s]
Chris@1494: @@formatters[name.to_s] = {:formatter => formatter, :helper => helper}
Chris@1494: end
Chris@1494:
Chris@1494: def formatter
Chris@1494: formatter_for(Setting.text_formatting)
Chris@1494: end
Chris@1494:
Chris@1494: def formatter_for(name)
Chris@1494: entry = @@formatters[name.to_s]
Chris@1494: (entry && entry[:formatter]) || Redmine::WikiFormatting::NullFormatter::Formatter
Chris@1494: end
Chris@1494:
Chris@1494: def helper_for(name)
Chris@1494: entry = @@formatters[name.to_s]
Chris@1494: (entry && entry[:helper]) || Redmine::WikiFormatting::NullFormatter::Helper
Chris@1494: end
Chris@1494:
Chris@1494: def format_names
Chris@1494: @@formatters.keys.map
Chris@1494: end
Chris@1494:
Chris@1494: def to_html(format, text, options = {})
Chris@1494: text = if Setting.cache_formatted_text? && text.size > 2.kilobyte && cache_store && cache_key = cache_key_for(format, text, options[:object], options[:attribute])
Chris@1494: # Text retrieved from the cache store may be frozen
Chris@1494: # We need to dup it so we can do in-place substitutions with gsub!
Chris@1494: cache_store.fetch cache_key do
Chris@1494: formatter_for(format).new(text).to_html
Chris@1494: end.dup
Chris@1494: else
Chris@1494: formatter_for(format).new(text).to_html
Chris@1494: end
Chris@1494: text
Chris@1494: end
Chris@1494:
Chris@1494: # Returns true if the text formatter supports single section edit
Chris@1494: def supports_section_edit?
Chris@1494: (formatter.instance_methods & ['update_section', :update_section]).any?
Chris@1494: end
Chris@1494:
Chris@1494: # Returns a cache key for the given text +format+, +text+, +object+ and +attribute+ or nil if no caching should be done
Chris@1494: def cache_key_for(format, text, object, attribute)
Chris@1494: if object && attribute && !object.new_record? && format.present?
Chris@1494: "formatted_text/#{format}/#{object.class.model_name.cache_key}/#{object.id}-#{attribute}-#{Digest::MD5.hexdigest text}"
Chris@1494: end
Chris@1494: end
Chris@1494:
Chris@1494: # Returns the cache store used to cache HTML output
Chris@1494: def cache_store
Chris@1494: ActionController::Base.cache_store
Chris@1494: end
Chris@1494: end
Chris@1494:
Chris@1494: module LinksHelper
Chris@1494: AUTO_LINK_RE = %r{
Chris@1494: ( # leading text
Chris@1494: <\w+.*?>| # leading HTML tag, or
Chris@1494: [\s\(\[,;]| # leading punctuation, or
Chris@1494: ^ # beginning of line
Chris@1494: )
Chris@1494: (
Chris@1494: (?:https?://)| # protocol spec, or
Chris@1494: (?:s?ftps?://)|
Chris@1494: (?:www\.) # www.*
Chris@1494: )
Chris@1494: (
Chris@1494: ([^<]\S*?) # url
Chris@1494: (\/)? # slash
Chris@1494: )
Chris@1494: ((?:>)?|[^[:alnum:]_\=\/;\(\)]*?) # post
Chris@1494: (?=<|\s|$)
Chris@1494: }x unless const_defined?(:AUTO_LINK_RE)
Chris@1494:
Chris@1494: # Destructively remplaces urls into clickable links
Chris@1494: def auto_link!(text)
Chris@1494: text.gsub!(AUTO_LINK_RE) do
Chris@1494: all, leading, proto, url, post = $&, $1, $2, $3, $6
Chris@1494: if leading =~ /=]?/
Chris@1494: # don't replace URL's that are already linked
Chris@1494: # and URL's prefixed with ! !> !< != (textile images)
Chris@1494: all
Chris@1494: else
Chris@1494: # Idea below : an URL with unbalanced parethesis and
Chris@1494: # ending by ')' is put into external parenthesis
Chris@1494: if ( url[-1]==?) and ((url.count("(") - url.count(")")) < 0 ) )
Chris@1494: url=url[0..-2] # discard closing parenth from url
Chris@1494: post = ")"+post # add closing parenth to post
Chris@1494: end
Chris@1494: content = proto + url
Chris@1494: href = "#{proto=="www."?"http://www.":proto}#{url}"
Chris@1494: %(#{leading}#{ERB::Util.html_escape content}#{post}).html_safe
Chris@1494: end
Chris@1494: end
Chris@1494: end
Chris@1494:
Chris@1494: # Destructively remplaces email addresses into clickable links
Chris@1494: def auto_mailto!(text)
Chris@1494: text.gsub!(/([\w\.!#\$%\-+.]+@[A-Za-z0-9\-]+(\.[A-Za-z0-9\-]+)+)/) do
Chris@1494: mail = $1
Chris@1494: if text.match(/]*>(.*)(#{Regexp.escape(mail)})(.*)<\/a>/)
Chris@1494: mail
Chris@1494: else
Chris@1494: %(#{ERB::Util.html_escape mail}).html_safe
Chris@1494: end
Chris@1494: end
Chris@1494: end
Chris@1494: end
Chris@1494:
Chris@1494: # Default formatter module
Chris@1494: module NullFormatter
Chris@1494: class Formatter
Chris@1494: include ActionView::Helpers::TagHelper
Chris@1494: include ActionView::Helpers::TextHelper
Chris@1494: include ActionView::Helpers::UrlHelper
Chris@1494: include Redmine::WikiFormatting::LinksHelper
Chris@1494:
Chris@1494: def initialize(text)
Chris@1494: @text = text
Chris@1494: end
Chris@1494:
Chris@1494: def to_html(*args)
Chris@1494: t = CGI::escapeHTML(@text)
Chris@1494: auto_link!(t)
Chris@1494: auto_mailto!(t)
Chris@1494: simple_format(t, {}, :sanitize => false)
Chris@1494: end
Chris@1494: end
Chris@1494:
Chris@1494: module Helper
Chris@1494: def wikitoolbar_for(field_id)
Chris@1494: end
Chris@1494:
Chris@1494: def heads_for_wiki_formatter
Chris@1494: end
Chris@1494:
Chris@1494: def initial_page_content(page)
Chris@1494: page.pretty_title.to_s
Chris@1494: end
Chris@1494: end
Chris@1494: end
Chris@1494: end
Chris@1494: end