| @@ -1,186 +1,183 | |||||
| 1 | # Redmine - project management software |
|
1 | # Redmine - project management software | |
| 2 | # Copyright (C) 2006-2014 Jean-Philippe Lang |
|
2 | # Copyright (C) 2006-2014 Jean-Philippe Lang | |
| 3 | # |
|
3 | # | |
| 4 | # This program is free software; you can redistribute it and/or |
|
4 | # This program is free software; you can redistribute it and/or | |
| 5 | # modify it under the terms of the GNU General Public License |
|
5 | # modify it under the terms of the GNU General Public License | |
| 6 | # as published by the Free Software Foundation; either version 2 |
|
6 | # as published by the Free Software Foundation; either version 2 | |
| 7 | # of the License, or (at your option) any later version. |
|
7 | # of the License, or (at your option) any later version. | |
| 8 | # |
|
8 | # | |
| 9 | # This program is distributed in the hope that it will be useful, |
|
9 | # This program is distributed in the hope that it will be useful, | |
| 10 | # but WITHOUT ANY WARRANTY; without even the implied warranty of |
|
10 | # but WITHOUT ANY WARRANTY; without even the implied warranty of | |
| 11 | # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the |
|
11 | # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the | |
| 12 | # GNU General Public License for more details. |
|
12 | # GNU General Public License for more details. | |
| 13 | # |
|
13 | # | |
| 14 | # You should have received a copy of the GNU General Public License |
|
14 | # You should have received a copy of the GNU General Public License | |
| 15 | # along with this program; if not, write to the Free Software |
|
15 | # along with this program; if not, write to the Free Software | |
| 16 | # Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. |
|
16 | # Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. | |
| 17 |
|
17 | |||
| 18 | require 'digest/md5' |
|
18 | require 'digest/md5' | |
| 19 |
|
19 | |||
| 20 | module Redmine |
|
20 | module Redmine | |
| 21 | module WikiFormatting |
|
21 | module WikiFormatting | |
| 22 | class StaleSectionError < Exception; end |
|
22 | class StaleSectionError < Exception; end | |
| 23 |
|
23 | |||
| 24 | @@formatters = {} |
|
24 | @@formatters = {} | |
| 25 |
|
25 | |||
| 26 | class << self |
|
26 | class << self | |
| 27 | def map |
|
27 | def map | |
| 28 | yield self |
|
28 | yield self | |
| 29 | end |
|
29 | end | |
| 30 |
|
30 | |||
| 31 | def register(name, formatter, helper, options={}) |
|
31 | def register(name, formatter, helper, options={}) | |
| 32 | name = name.to_s |
|
32 | name = name.to_s | |
| 33 | raise ArgumentError, "format name '#{name}' is already taken" if @@formatters[name] |
|
33 | raise ArgumentError, "format name '#{name}' is already taken" if @@formatters[name] | |
| 34 | @@formatters[name] = { |
|
34 | @@formatters[name] = { | |
| 35 | :formatter => formatter, |
|
35 | :formatter => formatter, | |
| 36 | :helper => helper, |
|
36 | :helper => helper, | |
| 37 | :label => options[:label] || name.humanize |
|
37 | :label => options[:label] || name.humanize | |
| 38 | } |
|
38 | } | |
| 39 | end |
|
39 | end | |
| 40 |
|
40 | |||
| 41 | def formatter |
|
41 | def formatter | |
| 42 | formatter_for(Setting.text_formatting) |
|
42 | formatter_for(Setting.text_formatting) | |
| 43 | end |
|
43 | end | |
| 44 |
|
44 | |||
| 45 | def formatter_for(name) |
|
45 | def formatter_for(name) | |
| 46 | entry = @@formatters[name.to_s] |
|
46 | entry = @@formatters[name.to_s] | |
| 47 | (entry && entry[:formatter]) || Redmine::WikiFormatting::NullFormatter::Formatter |
|
47 | (entry && entry[:formatter]) || Redmine::WikiFormatting::NullFormatter::Formatter | |
| 48 | end |
|
48 | end | |
| 49 |
|
49 | |||
| 50 | def helper_for(name) |
|
50 | def helper_for(name) | |
| 51 | entry = @@formatters[name.to_s] |
|
51 | entry = @@formatters[name.to_s] | |
| 52 | (entry && entry[:helper]) || Redmine::WikiFormatting::NullFormatter::Helper |
|
52 | (entry && entry[:helper]) || Redmine::WikiFormatting::NullFormatter::Helper | |
| 53 | end |
|
53 | end | |
| 54 |
|
54 | |||
| 55 | def format_names |
|
55 | def format_names | |
| 56 | @@formatters.keys.map |
|
56 | @@formatters.keys.map | |
| 57 | end |
|
57 | end | |
| 58 |
|
58 | |||
| 59 | def formats_for_select |
|
59 | def formats_for_select | |
| 60 | @@formatters.map {|name, options| [options[:label], name]} |
|
60 | @@formatters.map {|name, options| [options[:label], name]} | |
| 61 | end |
|
61 | end | |
| 62 |
|
62 | |||
| 63 | def to_html(format, text, options = {}) |
|
63 | def to_html(format, text, options = {}) | |
| 64 | text = if Setting.cache_formatted_text? && text.size > 2.kilobyte && cache_store && cache_key = cache_key_for(format, text, options[:object], options[:attribute]) |
|
64 | text = if Setting.cache_formatted_text? && text.size > 2.kilobyte && cache_store && cache_key = cache_key_for(format, text, options[:object], options[:attribute]) | |
| 65 | # Text retrieved from the cache store may be frozen |
|
65 | # Text retrieved from the cache store may be frozen | |
| 66 | # We need to dup it so we can do in-place substitutions with gsub! |
|
66 | # We need to dup it so we can do in-place substitutions with gsub! | |
| 67 | cache_store.fetch cache_key do |
|
67 | cache_store.fetch cache_key do | |
| 68 | formatter_for(format).new(text).to_html |
|
68 | formatter_for(format).new(text).to_html | |
| 69 | end.dup |
|
69 | end.dup | |
| 70 | else |
|
70 | else | |
| 71 | formatter_for(format).new(text).to_html |
|
71 | formatter_for(format).new(text).to_html | |
| 72 | end |
|
72 | end | |
| 73 | text |
|
73 | text | |
| 74 | end |
|
74 | end | |
| 75 |
|
75 | |||
| 76 | # Returns true if the text formatter supports single section edit |
|
76 | # Returns true if the text formatter supports single section edit | |
| 77 | def supports_section_edit? |
|
77 | def supports_section_edit? | |
| 78 | (formatter.instance_methods & ['update_section', :update_section]).any? |
|
78 | (formatter.instance_methods & ['update_section', :update_section]).any? | |
| 79 | end |
|
79 | end | |
| 80 |
|
80 | |||
| 81 | # Returns a cache key for the given text +format+, +text+, +object+ and +attribute+ or nil if no caching should be done |
|
81 | # Returns a cache key for the given text +format+, +text+, +object+ and +attribute+ or nil if no caching should be done | |
| 82 | def cache_key_for(format, text, object, attribute) |
|
82 | def cache_key_for(format, text, object, attribute) | |
| 83 | if object && attribute && !object.new_record? && format.present? |
|
83 | if object && attribute && !object.new_record? && format.present? | |
| 84 | "formatted_text/#{format}/#{object.class.model_name.cache_key}/#{object.id}-#{attribute}-#{Digest::MD5.hexdigest text}" |
|
84 | "formatted_text/#{format}/#{object.class.model_name.cache_key}/#{object.id}-#{attribute}-#{Digest::MD5.hexdigest text}" | |
| 85 | end |
|
85 | end | |
| 86 | end |
|
86 | end | |
| 87 |
|
87 | |||
| 88 | # Returns the cache store used to cache HTML output |
|
88 | # Returns the cache store used to cache HTML output | |
| 89 | def cache_store |
|
89 | def cache_store | |
| 90 | ActionController::Base.cache_store |
|
90 | ActionController::Base.cache_store | |
| 91 | end |
|
91 | end | |
| 92 | end |
|
92 | end | |
| 93 |
|
93 | |||
| 94 | module LinksHelper |
|
94 | module LinksHelper | |
| 95 | AUTO_LINK_RE = %r{ |
|
95 | AUTO_LINK_RE = %r{ | |
| 96 | ( # leading text |
|
96 | ( # leading text | |
| 97 | <\w+[^>]*?>| # leading HTML tag, or |
|
97 | <\w+[^>]*?>| # leading HTML tag, or | |
| 98 | [\s\(\[,;]| # leading punctuation, or |
|
98 | [\s\(\[,;]| # leading punctuation, or | |
| 99 | ^ # beginning of line |
|
99 | ^ # beginning of line | |
| 100 | ) |
|
100 | ) | |
| 101 | ( |
|
101 | ( | |
| 102 | (?:https?://)| # protocol spec, or |
|
102 | (?:https?://)| # protocol spec, or | |
| 103 | (?:s?ftps?://)| |
|
103 | (?:s?ftps?://)| | |
| 104 | (?:www\.) # www.* |
|
104 | (?:www\.) # www.* | |
| 105 | ) |
|
105 | ) | |
| 106 | ( |
|
106 | ( | |
| 107 | ([^<]\S*?) # url |
|
107 | ([^<]\S*?) # url | |
| 108 | (\/)? # slash |
|
108 | (\/)? # slash | |
| 109 | ) |
|
109 | ) | |
| 110 | ((?:>)?|[^[:alnum:]_\=\/;\(\)]*?) # post |
|
110 | ((?:>)?|[^[:alnum:]_\=\/;\(\)]*?) # post | |
| 111 | (?=<|\s|$) |
|
111 | (?=<|\s|$) | |
| 112 | }x unless const_defined?(:AUTO_LINK_RE) |
|
112 | }x unless const_defined?(:AUTO_LINK_RE) | |
| 113 |
|
113 | |||
| 114 | # Destructively replaces urls into clickable links |
|
114 | # Destructively replaces urls into clickable links | |
| 115 | def auto_link!(text) |
|
115 | def auto_link!(text) | |
| 116 | Rails.logger.debug "=====================" |
|
|||
| 117 | Rails.logger.debug text |
|
116 | Rails.logger.debug text | |
| 118 | Rails.logger.debug "=====================" |
|
|||
| 119 | text.gsub!(AUTO_LINK_RE) do |
|
117 | text.gsub!(AUTO_LINK_RE) do | |
| 120 | all, leading, proto, url, post = $&, $1, $2, $3, $6 |
|
118 | all, leading, proto, url, post = $&, $1, $2, $3, $6 | |
| 121 | Rails.logger.debug all |
|
|||
| 122 | if leading =~ /<a\s/i || leading =~ /![<>=]?/ |
|
119 | if leading =~ /<a\s/i || leading =~ /![<>=]?/ | |
| 123 | # don't replace URLs that are already linked |
|
120 | # don't replace URLs that are already linked | |
| 124 | # and URLs prefixed with ! !> !< != (textile images) |
|
121 | # and URLs prefixed with ! !> !< != (textile images) | |
| 125 | all |
|
122 | all | |
| 126 | else |
|
123 | else | |
| 127 | # Idea below : an URL with unbalanced parenthesis and |
|
124 | # Idea below : an URL with unbalanced parenthesis and | |
| 128 | # ending by ')' is put into external parenthesis |
|
125 | # ending by ')' is put into external parenthesis | |
| 129 | if ( url[-1]==?) and ((url.count("(") - url.count(")")) < 0 ) ) |
|
126 | if ( url[-1]==?) and ((url.count("(") - url.count(")")) < 0 ) ) | |
| 130 | url=url[0..-2] # discard closing parenthesis from url |
|
127 | url=url[0..-2] # discard closing parenthesis from url | |
| 131 | post = ")"+post # add closing parenthesis to post |
|
128 | post = ")"+post # add closing parenthesis to post | |
| 132 | end |
|
129 | end | |
| 133 | content = proto + url |
|
130 | content = proto + url | |
| 134 | href = "#{proto=="www."?"http://www.":proto}#{url}" |
|
131 | href = "#{proto=="www."?"http://www.":proto}#{url}" | |
| 135 | %(#{leading}<a class="external" href="#{ERB::Util.html_escape href}">#{ERB::Util.html_escape content}</a>#{post}).html_safe |
|
132 | %(#{leading}<a class="external" href="#{ERB::Util.html_escape href}">#{ERB::Util.html_escape content}</a>#{post}).html_safe | |
| 136 | end |
|
133 | end | |
| 137 | end |
|
134 | end | |
| 138 | end |
|
135 | end | |
| 139 |
|
136 | |||
| 140 | # Destructively replaces email addresses into clickable links |
|
137 | # Destructively replaces email addresses into clickable links | |
| 141 | def auto_mailto!(text) |
|
138 | def auto_mailto!(text) | |
| 142 | text.gsub!(/([\w\.!#\$%\-+.]+@[A-Za-z0-9\-]+(\.[A-Za-z0-9\-]+)+)/) do |
|
139 | text.gsub!(/([\w\.!#\$%\-+.]+@[A-Za-z0-9\-]+(\.[A-Za-z0-9\-]+)+)/) do | |
| 143 | mail = $1 |
|
140 | mail = $1 | |
| 144 | if text.match(/<a\b[^>]*>(.*)(#{Regexp.escape(mail)})(.*)<\/a>/) |
|
141 | if text.match(/<a\b[^>]*>(.*)(#{Regexp.escape(mail)})(.*)<\/a>/) | |
| 145 |
|
142 | |||
| 146 | else |
|
143 | else | |
| 147 | %(<a class="email" href="mailto:#{ERB::Util.html_escape mail}">#{ERB::Util.html_escape mail}</a>).html_safe |
|
144 | %(<a class="email" href="mailto:#{ERB::Util.html_escape mail}">#{ERB::Util.html_escape mail}</a>).html_safe | |
| 148 | end |
|
145 | end | |
| 149 | end |
|
146 | end | |
| 150 | end |
|
147 | end | |
| 151 | end |
|
148 | end | |
| 152 |
|
149 | |||
| 153 | # Default formatter module |
|
150 | # Default formatter module | |
| 154 | module NullFormatter |
|
151 | module NullFormatter | |
| 155 | class Formatter |
|
152 | class Formatter | |
| 156 | include ActionView::Helpers::TagHelper |
|
153 | include ActionView::Helpers::TagHelper | |
| 157 | include ActionView::Helpers::TextHelper |
|
154 | include ActionView::Helpers::TextHelper | |
| 158 | include ActionView::Helpers::UrlHelper |
|
155 | include ActionView::Helpers::UrlHelper | |
| 159 | include Redmine::WikiFormatting::LinksHelper |
|
156 | include Redmine::WikiFormatting::LinksHelper | |
| 160 |
|
157 | |||
| 161 | def initialize(text) |
|
158 | def initialize(text) | |
| 162 | @text = text |
|
159 | @text = text | |
| 163 | end |
|
160 | end | |
| 164 |
|
161 | |||
| 165 | def to_html(*args) |
|
162 | def to_html(*args) | |
| 166 | t = CGI::escapeHTML(@text) |
|
163 | t = CGI::escapeHTML(@text) | |
| 167 | auto_link!(t) |
|
164 | auto_link!(t) | |
| 168 | auto_mailto!(t) |
|
165 | auto_mailto!(t) | |
| 169 | simple_format(t, {}, :sanitize => false) |
|
166 | simple_format(t, {}, :sanitize => false) | |
| 170 | end |
|
167 | end | |
| 171 | end |
|
168 | end | |
| 172 |
|
169 | |||
| 173 | module Helper |
|
170 | module Helper | |
| 174 | def wikitoolbar_for(field_id) |
|
171 | def wikitoolbar_for(field_id) | |
| 175 | end |
|
172 | end | |
| 176 |
|
173 | |||
| 177 | def heads_for_wiki_formatter |
|
174 | def heads_for_wiki_formatter | |
| 178 | end |
|
175 | end | |
| 179 |
|
176 | |||
| 180 | def initial_page_content(page) |
|
177 | def initial_page_content(page) | |
| 181 | page.pretty_title.to_s |
|
178 | page.pretty_title.to_s | |
| 182 | end |
|
179 | end | |
| 183 | end |
|
180 | end | |
| 184 | end |
|
181 | end | |
| 185 | end |
|
182 | end | |
| 186 | end |
|
183 | end | |
General Comments 0
You need to be logged in to leave comments.
Login now