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