Adds a setting to cache textile rendering (off by default).

* it uses ActionController cache store which is MemoryStore by default and can be configured with config.action_controller.cache_store * macro processing was moved out of textile rendering so that it doesn't get cached * no noticeable improvement is expected for small portions of text, so only texts larger than 2KB are cached git-svn-id: svn+ssh://rubyforge.org/var/svn/redmine/trunk@3372 e93f8b46-1217-0410-a6f0-8f06a7374b81

Adds a setting to cache textile rendering (off by default).
* it uses ActionController cache store which is MemoryStore by default and can be configured with config.action_controller.cache_store * macro processing was moved out of textile rendering so that it doesn't get cached * no noticeable improvement is expected for small portions of text, so only texts larger than 2KB are cached git-svn-id: svn+ssh://rubyforge.org/var/svn/redmine/trunk@3372 e93f8b46-1217-0410-a6f0-8f06a7374b81
2ad8242a · Jean-Philippe Lang · 6c8b87fb · 2ad8242a · 2ad8242a · 2ad8242a
Commit 2ad8242a authored Feb 06, 2010 by Jean-Philippe Lang
44 changed files
--- a/app/helpers/application_helper.rb
+++ b/app/helpers/application_helper.rb
@@ -396,13 +396,14 @@ module ApplicationHelper
      text = args.shift
    when 2
      obj = args.shift
-      text = obj.send(args.shift).to_s
+      attr = args.shift
+      text = obj.send(attr).to_s
    else
      raise ArgumentError, 'invalid arguments to textilizable'
    end
    return '' if text.blank?
-    text = Redmine::WikiFormatting.to_html(Setting.text_formatting, text) { |macro, args| exec_macro(macro, obj, args) }
+    text = Redmine::WikiFormatting.to_html(Setting.text_formatting, text, :object => obj, :attribute => attr) { |macro, args| exec_macro(macro, obj, args) }
    only_path = options.delete(:only_path) == false ? false : true

--- a/app/views/settings/_general.rhtml
+++ b/app/views/settings/_general.rhtml
@@ -20,6 +20,8 @@
 <p><%= setting_select :text_formatting, Redmine::WikiFormatting.format_names.collect{|name| [name, name.to_s]}, :blank => :label_none %></p>
+<p><%= setting_check_box :cache_formatted_text %></p>
 <p><%= setting_select :wiki_compression, [['Gzip', 'gzip']], :blank => :label_none %></p>
 <p><%= setting_text_field :feeds_limit, :size => 6 %></p>

--- a/config/environment.rb
+++ b/config/environment.rb
@@ -32,7 +32,7 @@ Rails::Initializer.run do |config|
  # Enable page/fragment caching by setting a file-based store
  # (remember to create the caching directory and make it readable to the application)
-  # config.action_controller.fragment_cache_store = :file_store, "#{RAILS_ROOT}/cache"
+  # config.action_controller.cache_store = :file_store, "#{RAILS_ROOT}/tmp/cache"
  # Activate observers that should always be running
  # config.active_record.observers = :cacher, :garbage_collector

--- a/config/locales/bg.yml
+++ b/config/locales/bg.yml
@@ -879,3 +879,4 @@ bg:
  label_board_sticky: Sticky
  label_board_locked: Locked
  permission_export_wiki_pages: Export wiki pages
+  setting_cache_formatted_text: Cache formatted text
--- a/config/locales/bs.yml
+++ b/config/locales/bs.yml
@@ -903,3 +903,4 @@ bs:
  label_board_sticky: Sticky
  label_board_locked: Locked
  permission_export_wiki_pages: Export wiki pages
+  setting_cache_formatted_text: Cache formatted text
--- a/config/locales/ca.yml
+++ b/config/locales/ca.yml
@@ -882,3 +882,4 @@ ca:
  label_board_sticky: Sticky
  label_board_locked: Locked
  permission_export_wiki_pages: Export wiki pages
+  setting_cache_formatted_text: Cache formatted text
--- a/config/locales/cs.yml
+++ b/config/locales/cs.yml
@@ -885,3 +885,4 @@ cs:
  label_board_sticky: Sticky
  label_board_locked: Locked
  permission_export_wiki_pages: Export wiki pages
+  setting_cache_formatted_text: Cache formatted text
--- a/config/locales/da.yml
+++ b/config/locales/da.yml
@@ -905,3 +905,4 @@ da:
  label_board_sticky: Sticky
  label_board_locked: Locked
  permission_export_wiki_pages: Export wiki pages
+  setting_cache_formatted_text: Cache formatted text
--- a/config/locales/de.yml
+++ b/config/locales/de.yml
@@ -905,3 +905,4 @@ de:
  label_board_sticky: Sticky
  label_board_locked: Locked
  permission_export_wiki_pages: Export wiki pages
+  setting_cache_formatted_text: Cache formatted text
--- a/config/locales/el.yml
+++ b/config/locales/el.yml
@@ -885,3 +885,4 @@ el:
  label_board_sticky: Sticky
  label_board_locked: Locked
  permission_export_wiki_pages: Export wiki pages
+  setting_cache_formatted_text: Cache formatted text
--- a/config/locales/en.yml
+++ b/config/locales/en.yml
@@ -329,6 +329,7 @@ en:
  setting_issue_done_ratio_issue_status: Use the issue status
  setting_start_of_week: Start calendars on
  setting_rest_api_enabled: Enable REST web service
+  setting_cache_formatted_text: Cache formatted text
  permission_add_project: Create project
  permission_add_subprojects: Create subprojects

--- a/config/locales/es.yml
+++ b/config/locales/es.yml
@@ -929,3 +929,4 @@ es:
  label_board_sticky: Sticky
  label_board_locked: Locked
  permission_export_wiki_pages: Export wiki pages
+  setting_cache_formatted_text: Cache formatted text
--- a/config/locales/eu.yml
+++ b/config/locales/eu.yml
@@ -889,3 +889,4 @@ eu:
  label_board_sticky: Sticky
  label_board_locked: Locked
  permission_export_wiki_pages: Export wiki pages
+  setting_cache_formatted_text: Cache formatted text
--- a/config/locales/fi.yml
+++ b/config/locales/fi.yml
@@ -915,3 +915,4 @@ fi:
  label_board_sticky: Sticky
  label_board_locked: Locked
  permission_export_wiki_pages: Export wiki pages
+  setting_cache_formatted_text: Cache formatted text
--- a/config/locales/fr.yml
+++ b/config/locales/fr.yml
@@ -352,6 +352,7 @@ fr:
  setting_rest_api_enabled: Activer l'API REST
  setting_gravatar_default: Image Gravatar par défaut
  setting_start_of_week: Jour de début des calendriers
+  setting_cache_formatted_text: Mettre en cache le texte formaté
  permission_add_project: Créer un projet
  permission_add_subprojects: Créer des sous-projets

--- a/config/locales/gl.yml
+++ b/config/locales/gl.yml
@@ -905,3 +905,4 @@ gl:
  label_board_sticky: Sticky
  label_board_locked: Locked
  permission_export_wiki_pages: Export wiki pages
+  setting_cache_formatted_text: Cache formatted text
--- a/config/locales/he.yml
+++ b/config/locales/he.yml
@@ -889,3 +889,4 @@ he:
  label_board_sticky: Sticky
  label_board_locked: Locked
  permission_export_wiki_pages: Export wiki pages
+  setting_cache_formatted_text: Cache formatted text
--- a/config/locales/hr.yml
+++ b/config/locales/hr.yml
@@ -892,3 +892,4 @@ hr:
  label_board_sticky: Sticky
  label_board_locked: Locked
  permission_export_wiki_pages: Export wiki pages
+  setting_cache_formatted_text: Cache formatted text
--- a/config/locales/hu.yml
+++ b/config/locales/hu.yml
@@ -910,3 +910,4 @@
  label_board_sticky: Sticky
  label_board_locked: Locked
  permission_export_wiki_pages: Export wiki pages
+  setting_cache_formatted_text: Cache formatted text
--- a/config/locales/id.yml
+++ b/config/locales/id.yml
@@ -897,3 +897,4 @@ id:
  label_board_sticky: Sticky
  label_board_locked: Locked
  permission_export_wiki_pages: Export wiki pages
+  setting_cache_formatted_text: Cache formatted text
--- a/config/locales/it.yml
+++ b/config/locales/it.yml
@@ -892,3 +892,4 @@ it:
  label_board_sticky: Sticky
  label_board_locked: Locked
  permission_export_wiki_pages: Export wiki pages
+  setting_cache_formatted_text: Cache formatted text
--- a/config/locales/ja.yml
+++ b/config/locales/ja.yml
@@ -914,3 +914,4 @@ ja:
  enumeration_activities: 作業分類 (時間トラッキング)
  enumeration_system_activity: システム作業分類
  permission_export_wiki_pages: Export wiki pages
+  setting_cache_formatted_text: Cache formatted text
--- a/config/locales/ko.yml
+++ b/config/locales/ko.yml
@@ -945,3 +945,4 @@ ko:
  label_board_sticky: Sticky
  label_board_locked: Locked
  permission_export_wiki_pages: Export wiki pages
+  setting_cache_formatted_text: Cache formatted text
--- a/config/locales/lt.yml
+++ b/config/locales/lt.yml
@@ -953,3 +953,4 @@ lt:
  label_board_sticky: Sticky
  label_board_locked: Locked
  permission_export_wiki_pages: Export wiki pages
+  setting_cache_formatted_text: Cache formatted text
--- a/config/locales/nl.yml
+++ b/config/locales/nl.yml
@@ -867,3 +867,4 @@ nl:
  label_board_sticky: Sticky
  label_board_locked: Locked
  permission_export_wiki_pages: Export wiki pages
+  setting_cache_formatted_text: Cache formatted text
--- a/config/locales/no.yml
+++ b/config/locales/no.yml
@@ -880,3 +880,4 @@
  label_board_sticky: Sticky
  label_board_locked: Locked
  permission_export_wiki_pages: Export wiki pages
+  setting_cache_formatted_text: Cache formatted text
--- a/config/locales/pl.yml
+++ b/config/locales/pl.yml
@@ -910,3 +910,4 @@ pl:
  label_board_sticky: Sticky
  label_board_locked: Locked
  permission_export_wiki_pages: Export wiki pages
+  setting_cache_formatted_text: Cache formatted text
--- a/config/locales/pt-BR.yml
+++ b/config/locales/pt-BR.yml
@@ -913,3 +913,4 @@ pt-BR:
  label_board_locked: Travado
  label_change_log: Registro de alterações
  permission_export_wiki_pages: Export wiki pages
+  setting_cache_formatted_text: Cache formatted text
--- a/config/locales/pt.yml
+++ b/config/locales/pt.yml
@@ -897,3 +897,4 @@ pt:
  label_board_sticky: Sticky
  label_board_locked: Locked
  permission_export_wiki_pages: Export wiki pages
+  setting_cache_formatted_text: Cache formatted text
--- a/config/locales/ro.yml
+++ b/config/locales/ro.yml
@@ -882,3 +882,4 @@ ro:
  label_board_sticky: Sticky
  label_board_locked: Locked
  permission_export_wiki_pages: Export wiki pages
+  setting_cache_formatted_text: Cache formatted text
--- a/config/locales/ru.yml
+++ b/config/locales/ru.yml
@@ -993,3 +993,4 @@ ru:
  label_board_sticky: Прикреплена
  label_board_locked: Заблокирована
  permission_export_wiki_pages: Export wiki pages
+  setting_cache_formatted_text: Cache formatted text
--- a/config/locales/sk.yml
+++ b/config/locales/sk.yml
@@ -884,3 +884,4 @@ sk:
  label_board_sticky: Sticky
  label_board_locked: Locked
  permission_export_wiki_pages: Export wiki pages
+  setting_cache_formatted_text: Cache formatted text
--- a/config/locales/sl.yml
+++ b/config/locales/sl.yml
@@ -881,3 +881,4 @@ sl:
  label_board_sticky: Sticky
  label_board_locked: Locked
  permission_export_wiki_pages: Export wiki pages
+  setting_cache_formatted_text: Cache formatted text
--- a/config/locales/sr.yml
+++ b/config/locales/sr.yml
@@ -900,3 +900,4 @@
  label_board_sticky: Sticky
  label_board_locked: Locked
  permission_export_wiki_pages: Export wiki pages
+  setting_cache_formatted_text: Cache formatted text
--- a/config/locales/sv.yml
+++ b/config/locales/sv.yml
@@ -934,3 +934,4 @@ sv:
  enumeration_activities: Aktiviteter (tidsuppföljning)
  enumeration_system_activity: Systemaktivitet
  permission_export_wiki_pages: Export wiki pages
+  setting_cache_formatted_text: Cache formatted text
--- a/config/locales/th.yml
+++ b/config/locales/th.yml
@@ -882,3 +882,4 @@ th:
  label_board_sticky: Sticky
  label_board_locked: Locked
  permission_export_wiki_pages: Export wiki pages
+  setting_cache_formatted_text: Cache formatted text
--- a/config/locales/tr.yml
+++ b/config/locales/tr.yml
@@ -912,3 +912,4 @@ tr:
  label_board_sticky: Sticky
  label_board_locked: Locked
  permission_export_wiki_pages: Export wiki pages
+  setting_cache_formatted_text: Cache formatted text
--- a/config/locales/uk.yml
+++ b/config/locales/uk.yml
@@ -881,3 +881,4 @@ uk:
  label_board_sticky: Sticky
  label_board_locked: Locked
  permission_export_wiki_pages: Export wiki pages
+  setting_cache_formatted_text: Cache formatted text
--- a/config/locales/vi.yml
+++ b/config/locales/vi.yml
@@ -944,3 +944,4 @@ vi:
  label_board_sticky: Sticky
  label_board_locked: Locked
  permission_export_wiki_pages: Export wiki pages
+  setting_cache_formatted_text: Cache formatted text
--- a/config/locales/zh-TW.yml
+++ b/config/locales/zh-TW.yml
@@ -976,3 +976,4 @@
  enumeration_activities: 活動 (時間追蹤)
  enumeration_system_activity: 系統活動
  permission_export_wiki_pages: Export wiki pages
+  setting_cache_formatted_text: Cache formatted text
--- a/config/locales/zh.yml
+++ b/config/locales/zh.yml
@@ -907,3 +907,4 @@ zh:
  label_board_sticky: Sticky
  label_board_locked: Locked
  permission_export_wiki_pages: Export wiki pages
+  setting_cache_formatted_text: Cache formatted text
--- a/config/settings.yml
+++ b/config/settings.yml
@@ -53,6 +53,8 @@ plain_text_mail:
  default: 0
 text_formatting:
  default: textile
+cache_formatted_text:
+  default: 0
 wiki_compression:
  default: ""
 default_language:

--- a/lib/redmine/wiki_formatting.rb
+++ b/lib/redmine/wiki_formatting.rb
@@ -44,7 +44,58 @@ module Redmine
      end
      def to_html(format, text, options = {}, &block)
-        formatter_for(format).new(text).to_html(&block)
+        text = if Setting.cache_formatted_text? && text.size > 2.kilobyte && cache && cache_key = cache_key_for(format, options[:object], options[:attribute])
+          # Text retrieved from the cache store may be frozen
+          # We need to dup it so we can do in-place substitutions with gsub!
+          cache.fetch cache_key do
+            formatter_for(format).new(text).to_html
+          end.dup
+        else
+          formatter_for(format).new(text).to_html
+        end
+        if block_given?
+          execute_macros(text, block)
+        end
+        text
+      end
+      # Returns a cache key for the given text +format+, +object+ and +attribute+ or nil if no caching should be done
+      def cache_key_for(format, object, attribute)
+        if object && attribute && !object.new_record? && object.respond_to?(:updated_on) && !format.blank?
+          "formatted_text/#{format}/#{object.class.model_name.cache_key}/#{object.id}-#{attribute}-#{object.updated_on.to_s(:number)}"
+        end
+      end
+      # Returns the cache store used to cache HTML output
+      def cache
+        ActionController::Base.cache_store
+      end
+      MACROS_RE = /
+                    (!)?                        # escaping
+                    (
+                    \{\{                        # opening tag
+                    ([\w]+)                     # macro name
+                    (\(([^\}]*)\))?             # optional arguments
+                    \}\}                        # closing tag
+                    )
+                  /x unless const_defined?(:MACROS_RE)
+      # Macros substitution
+      def execute_macros(text, macros_runner)
+        text.gsub!(MACROS_RE) do
+          esc, all, macro = $1, $2, $3.downcase
+          args = ($5 || '').split(',').each(&:strip)
+          if esc.nil?
+            begin
+              macros_runner.call(macro, args)
+            rescue => e
+              "<div class=\"flash error\">Error executing the <strong>#{macro}</strong> macro (#{e})</div>"
+            end || all
+          else
+            all
+          end
+        end
      end
    end

--- a/lib/redmine/wiki_formatting/textile/formatter.rb
+++ b/lib/redmine/wiki_formatting/textile/formatter.rb
@@ -24,7 +24,7 @@ module Redmine
      class Formatter < RedCloth3
        # auto_link rule after textile rules so that it doesn't break !image_url! tags
-        RULES = [:textile, :block_markdown_rule, :inline_auto_link, :inline_auto_mailto, :inline_toc, :inline_macros]
+        RULES = [:textile, :block_markdown_rule, :inline_auto_link, :inline_auto_mailto, :inline_toc]
        def initialize(*args)
          super
@@ -33,9 +33,8 @@ module Redmine
          self.filter_styles=true
        end
-        def to_html(*rules, &block)
+        def to_html(*rules)
          @toc = []
-          @macros_runner = block
          super(*RULES).to_s
        end
@@ -102,32 +101,6 @@ module Redmine
          end
        end
-        MACROS_RE = /
-                      (!)?                        # escaping
-                      (
-                      \{\{                        # opening tag
-                      ([\w]+)                     # macro name
-                      (\(([^\}]*)\))?             # optional arguments
-                      \}\}                        # closing tag
-                      )
-                    /x unless const_defined?(:MACROS_RE)
-        def inline_macros(text)
-          text.gsub!(MACROS_RE) do
-            esc, all, macro = $1, $2, $3.downcase
-            args = ($5 || '').split(',').each(&:strip)
-            if esc.nil?
-              begin
-                @macros_runner.call(macro, args)
-              rescue => e
-                "<div class=\"flash error\">Error executing the <strong>#{macro}</strong> macro (#{e})</div>"
-              end || all
-            else
-              all
-            end
-          end
-        end
        AUTO_LINK_RE = %r{
                        (                          # leading text
                          <\w+.*?>|                # leading HTML tag, or