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