Chris@1494: # Redmine - project management software
Chris@1494: # Copyright (C) 2006-2014  Jean-Philippe Lang
Chris@1494: #
Chris@1494: # This program is free software; you can redistribute it and/or
Chris@1494: # modify it under the terms of the GNU General Public License
Chris@1494: # as published by the Free Software Foundation; either version 2
Chris@1494: # of the License, or (at your option) any later version.
Chris@1494: #
Chris@1494: # This program is distributed in the hope that it will be useful,
Chris@1494: # but WITHOUT ANY WARRANTY; without even the implied warranty of
Chris@1494: # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
Chris@1494: # GNU General Public License for more details.
Chris@1494: #
Chris@1494: # You should have received a copy of the GNU General Public License
Chris@1494: # along with this program; if not, write to the Free Software
Chris@1494: # Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
Chris@1494: 
Chris@1494: module Redmine
Chris@1494:   module WikiFormatting
Chris@1494:     module Macros
Chris@1494:       module Definitions
Chris@1494:         # Returns true if +name+ is the name of an existing macro
Chris@1494:         def macro_exists?(name)
Chris@1494:           Redmine::WikiFormatting::Macros.available_macros.key?(name.to_sym)
Chris@1494:         end
Chris@1494: 
Chris@1494:         def exec_macro(name, obj, args, text)
Chris@1494:           macro_options = Redmine::WikiFormatting::Macros.available_macros[name.to_sym]
Chris@1494:           return unless macro_options
Chris@1494: 
Chris@1494:           method_name = "macro_#{name}"
Chris@1494:           unless macro_options[:parse_args] == false
Chris@1494:             args = args.split(',').map(&:strip)
Chris@1494:           end
Chris@1494: 
Chris@1494:           begin
Chris@1494:             if self.class.instance_method(method_name).arity == 3
Chris@1494:               send(method_name, obj, args, text)
Chris@1494:             elsif text
Chris@1494:               raise "This macro does not accept a block of text"
Chris@1494:             else
Chris@1494:               send(method_name, obj, args)
Chris@1494:             end
Chris@1494:           rescue => e
Chris@1494:             "<div class=\"flash error\">Error executing the <strong>#{h name}</strong> macro (#{h e.to_s})</div>".html_safe
Chris@1494:           end
Chris@1494:         end
Chris@1494: 
Chris@1494:         def extract_macro_options(args, *keys)
Chris@1494:           options = {}
Chris@1494:           while args.last.to_s.strip =~ %r{^(.+?)\=(.+)$} && keys.include?($1.downcase.to_sym)
Chris@1494:             options[$1.downcase.to_sym] = $2
Chris@1494:             args.pop
Chris@1494:           end
Chris@1494:           return [args, options]
Chris@1494:         end
Chris@1494:       end
Chris@1494: 
Chris@1494:       @@available_macros = {}
Chris@1494:       mattr_accessor :available_macros
Chris@1494: 
Chris@1494:       class << self
Chris@1494:         # Plugins can use this method to define new macros:
Chris@1494:         #
Chris@1494:         #   Redmine::WikiFormatting::Macros.register do
Chris@1494:         #     desc "This is my macro"
Chris@1494:         #     macro :my_macro do |obj, args|
Chris@1494:         #       "My macro output"
Chris@1494:         #     end
Chris@1494:         #   
Chris@1494:         #     desc "This is my macro that accepts a block of text"
Chris@1494:         #     macro :my_macro do |obj, args, text|
Chris@1494:         #       "My macro output"
Chris@1494:         #     end
Chris@1494:         #   end
Chris@1494:         def register(&block)
Chris@1494:           class_eval(&block) if block_given?
Chris@1494:         end
Chris@1494: 
Chris@1494:         # Defines a new macro with the given name, options and block.
Chris@1494:         #
Chris@1494:         # Options:
Chris@1494:         # * :desc - A description of the macro
Chris@1494:         # * :parse_args => false - Disables arguments parsing (the whole arguments 
Chris@1494:         #   string is passed to the macro)
Chris@1494:         #
Chris@1494:         # Macro blocks accept 2 or 3 arguments:
Chris@1494:         # * obj: the object that is rendered (eg. an Issue, a WikiContent...)
Chris@1494:         # * args: macro arguments
Chris@1494:         # * text: the block of text given to the macro (should be present only if the
Chris@1494:         #   macro accepts a block of text). text is a String or nil if the macro is
Chris@1494:         #   invoked without a block of text.  
Chris@1494:         #
Chris@1494:         # Examples:
Chris@1494:         # By default, when the macro is invoked, the coma separated list of arguments
Chris@1494:         # is split and passed to the macro block as an array. If no argument is given
Chris@1494:         # the macro will be invoked with an empty array:
Chris@1494:         #
Chris@1494:         #   macro :my_macro do |obj, args|
Chris@1494:         #     # args is an array
Chris@1494:         #     # and this macro do not accept a block of text
Chris@1494:         #   end
Chris@1494:         #
Chris@1494:         # You can disable arguments spliting with the :parse_args => false option. In
Chris@1494:         # this case, the full string of arguments is passed to the macro:
Chris@1494:         #
Chris@1494:         #   macro :my_macro, :parse_args => false do |obj, args|
Chris@1494:         #     # args is a string
Chris@1494:         #   end
Chris@1494:         #
Chris@1494:         # Macro can optionally accept a block of text:
Chris@1494:         #
Chris@1494:         #   macro :my_macro do |obj, args, text|
Chris@1494:         #     # this macro accepts a block of text
Chris@1494:         #   end
Chris@1494:         #
Chris@1494:         # Macros are invoked in formatted text using double curly brackets. Arguments
Chris@1494:         # must be enclosed in parenthesis if any. A new line after the macro name or the
Chris@1494:         # arguments starts the block of text that will be passe to the macro (invoking
Chris@1494:         # a macro that do not accept a block of text with some text will fail).
Chris@1494:         # Examples:
Chris@1494:         #
Chris@1494:         #   No arguments:
Chris@1494:         #   {{my_macro}}
Chris@1494:         #
Chris@1494:         #   With arguments:
Chris@1494:         #   {{my_macro(arg1, arg2)}}
Chris@1494:         #
Chris@1494:         #   With a block of text:
Chris@1494:         #   {{my_macro
Chris@1494:         #   multiple lines
Chris@1494:         #   of text
Chris@1494:         #   }}
Chris@1494:         #
Chris@1494:         #   With arguments and a block of text
Chris@1494:         #   {{my_macro(arg1, arg2)
Chris@1494:         #   multiple lines
Chris@1494:         #   of text
Chris@1494:         #   }}
Chris@1494:         #
Chris@1494:         # If a block of text is given, the closing tag }} must be at the start of a new line.
Chris@1494:         def macro(name, options={}, &block)
Chris@1494:           options.assert_valid_keys(:desc, :parse_args)
Chris@1494:           unless name.to_s.match(/\A\w+\z/)
Chris@1494:             raise "Invalid macro name: #{name} (only 0-9, A-Z, a-z and _ characters are accepted)"
Chris@1494:           end
Chris@1494:           unless block_given?
Chris@1494:             raise "Can not create a macro without a block!"
Chris@1494:           end
Chris@1494:           name = name.to_s.downcase.to_sym
Chris@1494:           available_macros[name] = {:desc => @@desc || ''}.merge(options)
Chris@1494:           @@desc = nil
Chris@1494:           Definitions.send :define_method, "macro_#{name}", &block
Chris@1494:         end
Chris@1494: 
Chris@1494:         # Sets description for the next macro to be defined
Chris@1494:         def desc(txt)
Chris@1494:           @@desc = txt
Chris@1494:         end
Chris@1494:       end
Chris@1494: 
Chris@1494:       # Builtin macros
Chris@1494:       desc "Sample macro."
Chris@1494:       macro :hello_world do |obj, args, text|
Chris@1494:         h("Hello world! Object: #{obj.class.name}, " + 
Chris@1494:           (args.empty? ? "Called with no argument" : "Arguments: #{args.join(', ')}") +
Chris@1494:           " and " + (text.present? ? "a #{text.size} bytes long block of text." : "no block of text.")
Chris@1494:         )
Chris@1494:       end
Chris@1494: 
Chris@1494:       desc "Displays a list of all available macros, including description if available."
Chris@1494:       macro :macro_list do |obj, args|
Chris@1494:         out = ''.html_safe
Chris@1494:         @@available_macros.each do |macro, options|
Chris@1494:           out << content_tag('dt', content_tag('code', macro.to_s))
Chris@1494:           out << content_tag('dd', textilizable(options[:desc]))
Chris@1494:         end
Chris@1494:         content_tag('dl', out)
Chris@1494:       end
Chris@1494: 
Chris@1494:       desc "Displays a list of child pages. With no argument, it displays the child pages of the current wiki page. Examples:\n\n" +
Chris@1494:              "  !{{child_pages}} -- can be used from a wiki page only\n" +
Chris@1494:              "  !{{child_pages(depth=2)}} -- display 2 levels nesting only\n"
Chris@1494:              "  !{{child_pages(Foo)}} -- lists all children of page Foo\n" +
Chris@1494:              "  !{{child_pages(Foo, parent=1)}} -- same as above with a link to page Foo"
Chris@1494:       macro :child_pages do |obj, args|
Chris@1494:         args, options = extract_macro_options(args, :parent, :depth)
Chris@1494:         options[:depth] = options[:depth].to_i if options[:depth].present?
Chris@1494: 
Chris@1494:         page = nil
Chris@1494:         if args.size > 0
Chris@1494:           page = Wiki.find_page(args.first.to_s, :project => @project)
Chris@1494:         elsif obj.is_a?(WikiContent) || obj.is_a?(WikiContent::Version)
Chris@1494:           page = obj.page
Chris@1494:         else
Chris@1494:           raise 'With no argument, this macro can be called from wiki pages only.'
Chris@1494:         end
Chris@1494:         raise 'Page not found' if page.nil? || !User.current.allowed_to?(:view_wiki_pages, page.wiki.project)
Chris@1494:         pages = page.self_and_descendants(options[:depth]).group_by(&:parent_id)
Chris@1494:         render_page_hierarchy(pages, options[:parent] ? page.parent_id : page.id)
Chris@1494:       end
Chris@1494: 
Chris@1494:       desc "Include a wiki page. Example:\n\n  !{{include(Foo)}}\n\nor to include a page of a specific project wiki:\n\n  !{{include(projectname:Foo)}}"
Chris@1494:       macro :include do |obj, args|
Chris@1494:         page = Wiki.find_page(args.first.to_s, :project => @project)
Chris@1494:         raise 'Page not found' if page.nil? || !User.current.allowed_to?(:view_wiki_pages, page.wiki.project)
Chris@1494:         @included_wiki_pages ||= []
Chris@1494:         raise 'Circular inclusion detected' if @included_wiki_pages.include?(page.title)
Chris@1494:         @included_wiki_pages << page.title
Chris@1494:         out = textilizable(page.content, :text, :attachments => page.attachments, :headings => false)
Chris@1494:         @included_wiki_pages.pop
Chris@1494:         out
Chris@1494:       end
Chris@1494: 
Chris@1494:       desc "Inserts of collapsed block of text. Example:\n\n  {{collapse(View details...)\nThis is a block of text that is collapsed by default.\nIt can be expanded by clicking a link.\n}}"
Chris@1494:       macro :collapse do |obj, args, text|
Chris@1494:         html_id = "collapse-#{Redmine::Utils.random_hex(4)}"
Chris@1494:         show_label = args[0] || l(:button_show)
Chris@1494:         hide_label = args[1] || args[0] || l(:button_hide)
Chris@1494:         js = "$('##{html_id}-show, ##{html_id}-hide').toggle(); $('##{html_id}').fadeToggle(150);"
Chris@1494:         out = ''.html_safe
Chris@1494:         out << link_to_function(show_label, js, :id => "#{html_id}-show", :class => 'collapsible collapsed')
Chris@1494:         out << link_to_function(hide_label, js, :id => "#{html_id}-hide", :class => 'collapsible', :style => 'display:none;')
Chris@1494:         out << content_tag('div', textilizable(text, :object => obj), :id => html_id, :class => 'collapsed-text', :style => 'display:none;')
Chris@1494:         out
Chris@1494:       end
Chris@1494: 
Chris@1494:       desc "Displays a clickable thumbnail of an attached image. Examples:\n\n<pre>{{thumbnail(image.png)}}\n{{thumbnail(image.png, size=300, title=Thumbnail)}}</pre>"
Chris@1494:       macro :thumbnail do |obj, args|
Chris@1494:         args, options = extract_macro_options(args, :size, :title)
Chris@1494:         filename = args.first
Chris@1494:         raise 'Filename required' unless filename.present?
Chris@1494:         size = options[:size]
Chris@1494:         raise 'Invalid size parameter' unless size.nil? || size.match(/^\d+$/)
Chris@1494:         size = size.to_i
Chris@1494:         size = nil unless size > 0
Chris@1494:         if obj && obj.respond_to?(:attachments) && attachment = Attachment.latest_attach(obj.attachments, filename)
Chris@1494:           title = options[:title] || attachment.title
Chris@1494:           img = image_tag(url_for(:controller => 'attachments', :action => 'thumbnail', :id => attachment, :size => size), :alt => attachment.filename)
Chris@1494:           link_to(img, url_for(:controller => 'attachments', :action => 'show', :id => attachment), :class => 'thumbnail', :title => title)
Chris@1494:         else
Chris@1494:           raise "Attachment #{filename} not found"
Chris@1494:         end
Chris@1494:       end
Chris@1494:     end
Chris@1494:   end
Chris@1494: end