jro_apps/redmine Commit - r1139:05823373724e

Added:...

Jean-Philippe Lang -

r1139:05823373724e

parent child

Context file:

r1139:05823373724e

Collapse all files

lib/redmine/wiki_formatting.rb +14 -7

             # redMine - project management software
             # Copyright (C) 2006-2007  Jean-Philippe Lang
             #
             # This program is free software; you can redistribute it and/or
             # modify it under the terms of the GNU General Public License
             # as published by the Free Software Foundation; either version 2
             # of the License, or (at your option) any later version.
             #
             # This program is distributed in the hope that it will be useful,
             # but WITHOUT ANY WARRANTY; without even the implied warranty of
             # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
             # GNU General Public License for more details.
             #
             # You should have received a copy of the GNU General Public License
             # along with this program; if not, write to the Free Software
             # Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
             require 'redcloth'
             require 'coderay'
             module Redmine
               module WikiFormatting
               private
                 class TextileFormatter < RedCloth
                   # auto_link rule after textile rules so that it doesn't break !image_url! tags
                   RULES = [:textile, :inline_auto_link, :inline_auto_mailto, :inline_toc, :inline_macros]
                   def initialize(*args)
                     super
                     self.hard_breaks=true
                     self.no_span_caps=true
                   end
                   def to_html(*rules, &block)
                     @toc = []
                     @macros_runner = block
                     super(*RULES).to_s
                   end
                 private
                   # Patch for RedCloth.  Fixed in RedCloth r128 but _why hasn't released it yet.
                   # <a href="http://code.whytheluckystiff.net/redcloth/changeset/128">http://code.whytheluckystiff.net/redcloth/changeset/128</a>
                   def hard_break( text )
                     text.gsub!( /(.)\n(?!\n|\Z| *([#*=]+(\s|$)|[{|]))/, "\\1<br />" ) if hard_breaks
                   end
                   # Patch to add code highlighting support to RedCloth
                   def smooth_offtags( text )
                     unless @pre_list.empty?
                       ## replace <pre> content
                       text.gsub!(/<redpre#(\d+)>/) do
                         content = @pre_list[$1.to_i]
                         if content.match(/<code\s+class="(\w+)">\s?(.+)/m)
                           content = "<code class=\"#{$1} CodeRay\">" +
                             CodeRay.scan($2, $1).html(:escape => false, :line_numbers => :inline)
                         end
                         content
                       end
                     end
                   end
                   # Patch to add 'table of content' support to RedCloth
                   def textile_p_withtoc(tag, atts, cite, content)
                     if tag =~ /^h(\d)$/
                       @toc << [$1.to_i, content]
                     end
                     content = "<a name=\"#{@toc.length}\" class=\"wiki-page\"></a>" + content
                     textile_p(tag, atts, cite, content)
                   end
                   alias :textile_h1 :textile_p_withtoc
                   alias :textile_h2 :textile_p_withtoc
                   alias :textile_h3 :textile_p_withtoc
                   def inline_toc(text)
                     text.gsub!(/<p>\{\{([<>]?)toc\}\}<\/p>/i) do
                       div_class = 'toc'
                       div_class << ' right' if $1 == '>'
                       div_class << ' left' if $1 == '<'
                       out = "<div class=\"#{div_class}\">"
                       @toc.each_with_index do |heading, index|
                         # remove wiki links from the item
                         toc_item = heading.last.gsub(/(\[\[|\]\])/, '')
                         out << "<a href=\"##{index+1}\" class=\"heading#{heading.first}\">#{toc_item}</a>"
                       end
                       out << '</div>'
                       out
                     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
-                      all, macro = $&, $1.downcase
+                      esc, all, macro = $1, $2, $3.downcase
-                      args = ($3 || '').split(',').each(&:strip)
+                      args = ($5 || '').split(',').each(&:strip)
-                      begin
+                      if esc.nil?
-                        @macros_runner.call(macro, args)
+                        begin
-                      rescue => e
+                          @macros_runner.call(macro, args)
-                        "<div class=\"flash error\">Error executing the <strong>#{macro}</strong> macro (#{e})</div>"
+                        rescue => e
-                      end || all
+                          "<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
                                       [^=<>!:'"/]|             # leading punctuation, or
                                       ^                        # beginning of line
                                     )
                                     (
                                       (?:https?://)|           # protocol spec, or
                                       (?:www\.)                # www.*
                                     )
                                     (
                                       (\S+?)                   # url
                                       (\/)?                    # slash
                                     )
                                     ([^\w\=\/;]*?)               # post
                                     (?=<|\s|$)
                                    }x unless const_defined?(:AUTO_LINK_RE)
                   # Turns all urls into clickable links (code from Rails).
                   def inline_auto_link(text)
                     text.gsub!(AUTO_LINK_RE) do
                       all, leading, proto, url, post = $&, $1, $2, $3, $6
                       if leading =~ /<a\s/i || leading =~ /![<>=]?/
                         # don't replace URL's that are already linked
                         # and URL's prefixed with ! !> !< != (textile images)
                         all
                       else
                         %(#{leading}<a class="external" href="#{proto=="www."?"http://www.":proto}#{url}">#{proto + url}</a>#{post})
                       end
                     end
                   end
                   # Turns all email addresses into clickable links (code from Rails).
                   def inline_auto_mailto(text)
                     text.gsub!(/([\w\.!#\$%\-+.]+@[A-Za-z0-9\-]+(\.[A-Za-z0-9\-]+)+)/) do
                       text = $1
                       %{<a href="mailto:#{$1}" class="email">#{text}</a>}
                     end
                   end
                 end
               public
                 def self.to_html(text, options = {}, &block)
                   TextileFormatter.new(text).to_html(&block)
                 end
               end
             end

lib/redmine/wiki_formatting/macros.rb +19 -2

             # redMine - project management software
             # Copyright (C) 2006-2007  Jean-Philippe Lang
             #
             # This program is free software; you can redistribute it and/or
             # modify it under the terms of the GNU General Public License
             # as published by the Free Software Foundation; either version 2
             # of the License, or (at your option) any later version.
             #
             # This program is distributed in the hope that it will be useful,
             # but WITHOUT ANY WARRANTY; without even the implied warranty of
             # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
             # GNU General Public License for more details.
             #
             # You should have received a copy of the GNU General Public License
             # along with this program; if not, write to the Free Software
             # Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
             module Redmine
               module WikiFormatting
                 module Macros
                   module Definitions
                     def exec_macro(name, obj, args)
                       method_name = "macro_#{name}"
                       send(method_name, obj, args) if respond_to?(method_name)
                     end
                   end
                   @@available_macros = {}
                   class << self
                     # Called with a block to define additional macros.
                     # Macro blocks accept 2 arguments:
                     # * obj: the object that is rendered
                     # * args: macro arguments
                     #
                     # Plugins can use this method to define new macros:
                     #
                     #   Redmine::WikiFormatting::Macros.register do
                     #     desc "This is my macro"
                     #     macro :my_macro do |obj, args|
                     #       "My macro output"
                     #     end
                     #   end
                     def register(&block)
                       class_eval(&block) if block_given?
                     end
                   private
                     # Defines a new macro with the given name and block.
                     def macro(name, &block)
                       name = name.to_sym if name.is_a?(String)
                       @@available_macros[name] = @@desc || ''
                       @@desc = nil
                       raise "Can not create a macro without a block!" unless block_given?
                       Definitions.send :define_method, "macro_#{name}".downcase, &block
                     end
                     # Sets description for the next macro to be defined
                     def desc(txt)
                       @@desc = txt
                     end
                   end
                   # Builtin macros
-                  desc "Example macro."
+                  desc "Sample macro."
                   macro :hello_world do |obj, args|
                     "Hello world! Object: #{obj.class.name}, " + (args.empty? ? "Called with no argument." : "Arguments: #{args.join(', ')}")
                   end
                   desc "Displays a list of all available macros, including description if available."
                   macro :macro_list do
                     out = ''
                     @@available_macros.keys.collect(&:to_s).sort.each do |macro|
                       out << content_tag('dt', content_tag('code', macro))
-                      out << content_tag('dd', simple_format(@@available_macros[macro.to_sym]))
+                      out << content_tag('dd', textilizable(@@available_macros[macro.to_sym]))
                     end
                     content_tag('dl', out)
                   end
+                  desc "Include a wiki page. Example:\n\n  !{{include(Foo)}}"
+                  macro :include do |obj, args|
+                    if @project && !@project.wiki.nil?
+                      page = @project.wiki.find_page(args.first)
+                      if page && page.content
+                        @included_wiki_pages ||= []
+                        raise 'Circular inclusion detected' if @included_wiki_pages.include?(page.title)
+                        @included_wiki_pages << page.title
+                        out = textilizable(page.content, :text)
+                        @included_wiki_pages.pop
+                        out
+                      else
+                        raise "Page #{args.first} doesn't exist"
+                      end
+                    end
+                  end
                 end
               end
             end

test/unit/helpers/application_helper_test.rb +3 0

             # redMine - project management software
             # Copyright (C) 2006-2007  Jean-Philippe Lang
             #
             # This program is free software; you can redistribute it and/or
             # modify it under the terms of the GNU General Public License
             # as published by the Free Software Foundation; either version 2
             # of the License, or (at your option) any later version.
             #
             # This program is distributed in the hope that it will be useful,
             # but WITHOUT ANY WARRANTY; without even the implied warranty of
             # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
             # GNU General Public License for more details.
             #
             # You should have received a copy of the GNU General Public License
             # along with this program; if not, write to the Free Software
             # Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
             require File.dirname(__FILE__) + '/../../test_helper'
             class ApplicationHelperTest < HelperTestCase
               include ApplicationHelper
               include ActionView::Helpers::TextHelper
               fixtures :projects, :repositories, :changesets, :trackers, :issue_statuses, :issues, :documents, :versions, :wikis, :wiki_pages, :wiki_contents
               def setup
                 super
               end
               def test_auto_links
                 to_test = {
                   'http://foo.bar' => '<a class="external" href="http://foo.bar">http://foo.bar</a>',
                   'http://foo.bar/~user' => '<a class="external" href="http://foo.bar/~user">http://foo.bar/~user</a>',
                   'http://foo.bar.' => '<a class="external" href="http://foo.bar">http://foo.bar</a>.',
                   'http://foo.bar/foo.bar#foo.bar.' => '<a class="external" href="http://foo.bar/foo.bar#foo.bar">http://foo.bar/foo.bar#foo.bar</a>.',
                   'www.foo.bar' => '<a class="external" href="http://www.foo.bar">www.foo.bar</a>',
                   'http://foo.bar/page?p=1&t=z&s=' => '<a class="external" href="http://foo.bar/page?p=1&#38;t=z&#38;s=">http://foo.bar/page?p=1&#38;t=z&#38;s=</a>',
                   'http://foo.bar/page#125' => '<a class="external" href="http://foo.bar/page#125">http://foo.bar/page#125</a>'
                 }
                 to_test.each { |text, result| assert_equal "<p>#{result}</p>", textilizable(text) }
               end
               def test_auto_mailto
                 assert_equal '<p><a href="mailto:test@foo.bar" class="email">test@foo.bar</a></p>',
                   textilizable('test@foo.bar')
               end
               def test_inline_images
                 to_test = {
                   '!http://foo.bar/image.jpg!' => '<img src="http://foo.bar/image.jpg" alt="" />',
                   'floating !>http://foo.bar/image.jpg!' => 'floating <div style="float:right"><img src="http://foo.bar/image.jpg" alt="" /></div>',
                   'with class !(some-class)http://foo.bar/image.jpg!' => 'with class <img src="http://foo.bar/image.jpg" class="some-class" alt="" />',
                   'with style !{width:100px;height100px}http://foo.bar/image.jpg!' => 'with style <img src="http://foo.bar/image.jpg" style="width:100px;height100px;" alt="" />',
                 }
                 to_test.each { |text, result| assert_equal "<p>#{result}</p>", textilizable(text) }
               end
               def test_textile_external_links
                 to_test = {
                   'This is a "link":http://foo.bar' => 'This is a <a href="http://foo.bar" class="external">link</a>',
                   'This is an intern "link":/foo/bar' => 'This is an intern <a href="/foo/bar">link</a>',
                   '"link (Link title)":http://foo.bar' => '<a href="http://foo.bar" title="Link title" class="external">link</a>'
                 }
                 to_test.each { |text, result| assert_equal "<p>#{result}</p>", textilizable(text) }
               end
               def test_redmine_links
                 issue_link = link_to('#3', {:controller => 'issues', :action => 'show', :id => 3},
                                            :class => 'issue', :title => 'Error 281 when updating a recipe (New)')
                 changeset_link = link_to('r1', {:controller => 'repositories', :action => 'revision', :id => 1, :rev => 1},
                                                :class => 'changeset', :title => 'My very first commit')
                 document_link = link_to('Test document', {:controller => 'documents', :action => 'show', :id => 1},
                                                          :class => 'document')
                 version_link = link_to('1.0', {:controller => 'versions', :action => 'show', :id => 2},
                                               :class => 'version')
                 to_test = {
                   '#3, #3 and #3.' => "#{issue_link}, #{issue_link} and #{issue_link}.",
                   'r1' => changeset_link,
                   'document#1' => document_link,
                   'document:"Test document"' => document_link,
                   'version#2' => version_link,
                   'version:1.0' => version_link,
                   'version:"1.0"' => version_link,
                   # escaping
                   '!#3.' => '#3.',
                   '!r1' => 'r1',
                   '!document#1' => 'document#1',
                   '!document:"Test document"' => 'document:"Test document"',
                   '!version#2' => 'version#2',
                   '!version:1.0' => 'version:1.0',
                   '!version:"1.0"' => 'version:"1.0"',
                 }
                 @project = Project.find(1)
                 to_test.each { |text, result| assert_equal "<p>#{result}</p>", textilizable(text) }
               end
               def test_wiki_links
                 to_test = {
                   '[[CookBook documentation]]' => '<a href="/wiki/ecookbook/CookBook_documentation" class="wiki-page">CookBook documentation</a>',
                   '[[Another page|Page]]' => '<a href="/wiki/ecookbook/Another_page" class="wiki-page">Page</a>',
                   # page that doesn't exist
                   '[[Unknown page]]' => '<a href="/wiki/ecookbook/Unknown_page" class="wiki-page new">Unknown page</a>',
                   '[[Unknown page|404]]' => '<a href="/wiki/ecookbook/Unknown_page" class="wiki-page new">404</a>',
                   # link to another project wiki
                   '[[onlinestore:]]' => '<a href="/wiki/onlinestore/" class="wiki-page">onlinestore</a>',
                   '[[onlinestore:|Wiki]]' => '<a href="/wiki/onlinestore/" class="wiki-page">Wiki</a>',
                   '[[onlinestore:Start page]]' => '<a href="/wiki/onlinestore/Start_page" class="wiki-page">Start page</a>',
                   '[[onlinestore:Start page|Text]]' => '<a href="/wiki/onlinestore/Start_page" class="wiki-page">Text</a>',
                   '[[onlinestore:Unknown page]]' => '<a href="/wiki/onlinestore/Unknown_page" class="wiki-page new">Unknown page</a>',
                   # escaping
                   '![[Another page|Page]]' => '[[Another page|Page]]',
                 }
                 @project = Project.find(1)
                 to_test.each { |text, result| assert_equal "<p>#{result}</p>", textilizable(text) }
               end
               def test_macro_hello_world
                 text = "{{hello_world}}"
                 assert textilizable(text).match(/Hello world!/)
+                # escaping
+                text = "!{{hello_world}}"
+                assert_equal '<p>{{hello_world}}</p>', textilizable(text)
               end
               def test_date_format_default
                 today = Date.today
                 Setting.date_format = ''
                 assert_equal l_date(today), format_date(today)
               end
               def test_date_format
                 today = Date.today
                 Setting.date_format = '%d %m %Y'
                 assert_equal today.strftime('%d %m %Y'), format_date(today)
               end
               def test_time_format_default
                 now = Time.now
                 Setting.date_format = ''
                 Setting.time_format = ''
                 assert_equal l_datetime(now), format_time(now)
                 assert_equal l_time(now), format_time(now, false)
               end
               def test_time_format
                 now = Time.now
                 Setting.date_format = '%d %m %Y'
                 Setting.time_format = '%H %M'
                 assert_equal now.strftime('%d %m %Y %H %M'), format_time(now)
                 assert_equal now.strftime('%H %M'), format_time(now, false)
               end
             end

General Comments 0

Write
Preview

You need to be logged in to leave comments. Login now

No TODOs yet

	Site-wide shortcuts
/	Use quick search box
g h	Goto home page
g g	Goto my private gists page
g G	Goto my public gists page
g 0-9	Goto bookmarked items from 0-9
n r	New repository page
n g	New gist page

	Repositories
g s	Goto summary page
g c	Goto changelog page
g f	Goto files page
g F	Goto files page with file search activated
g p	Goto pull requests page
g o	Goto repository settings
g O	Goto repository access permissions settings
t s	Toggle sidebar on some pages